ChimeSDKIdentity / Client / create_app_instance_admin

create_app_instance_admin#

ChimeSDKIdentity.Client.create_app_instance_admin(**kwargs)#

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions.

  • ChannelModerator actions across all channels in the AppInstance.

  • DeleteChannelMessage actions.

Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

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 ARN and name of the administrator, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

      • 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

  • ChimeSDKIdentity.Client.exceptions.BadRequestException

  • ChimeSDKIdentity.Client.exceptions.ConflictException

  • ChimeSDKIdentity.Client.exceptions.ForbiddenException

  • ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededException

  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException

  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException

  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException

  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException