Chime / Client / create_app_instance_admin

create_app_instance_admin#

Chime.Client.create_app_instance_admin(**kwargs)#

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, 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.

  • ChannelModerator actions across all channels in the AppInstance.

  • DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

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.create_app_instance_admin(
    AppInstanceAdminArn='string',
    AppInstanceArn='string'
)
Parameters:

  • AppInstanceAdminArn (string) –

    [REQUIRED]

    The ARN of the administrator of the current AppInstance.

  • AppInstanceArn (string) –

    [REQUIRED]

    The ARN of the AppInstance.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceAdmin': {
        'Arn': 'string',
        'Name': 'string'
    },
    'AppInstanceArn': 'string'
}

Response Structure

  • (dict) –

    • AppInstanceAdmin (dict) –

      The name and ARN of the admin for the AppInstance.

      • Arn (string) –

        The ARN in an Identity.

      • Name (string) –

        The name in an Identity.

    • AppInstanceArn (string) –

      The ARN of the of the admin for the AppInstance.

Exceptions

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ConflictException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.ResourceLimitExceededException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException