Chime / Client / update_app_instance

update_app_instance#

Chime.Client.update_app_instance(**kwargs)#

Updates AppInstance metadata.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.update_app_instance(
    AppInstanceArn='string',
    Name='string',
    Metadata='string'
)
Parameters:

  • AppInstanceArn (string) –

    [REQUIRED]

    The ARN of the AppInstance.

  • Name (string) –

    [REQUIRED]

    The name that you want to change.

  • Metadata (string) – The metadata that you want to change.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceArn': 'string'
}

Response Structure

  • (dict) –

    • AppInstanceArn (string) –

      The ARN of the AppInstance.

Exceptions

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ConflictException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException