Chime / Client / update_channel

update_channel#

Chime.Client.update_channel(**kwargs)#

Update a channel’s attributes.

Restriction: You can’t change a channel’s privacy.

Note

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

See also: AWS API Documentation

Request Syntax

response = client.update_channel(
    ChannelArn='string',
    Name='string',
    Mode='UNRESTRICTED'|'RESTRICTED',
    Metadata='string',
    ChimeBearer='string'
)
Parameters:

  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel.

  • Name (string) –

    [REQUIRED]

    The name of the channel.

  • Mode (string) –

    [REQUIRED]

    The mode of the update request.

  • Metadata (string) – The metadata for the update request.

  • ChimeBearer (string) – The AppInstanceUserArn of the user that makes the API call.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelArn': 'string'
}

Response Structure

  • (dict) –

    • ChannelArn (string) –

      The ARN of the channel.

Exceptions

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.ConflictException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException