create_app_instance

create_app_instance(**kwargs)

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

identity

See also: AWS API Documentation

Request Syntax

response = client.create_app_instance(
    Name='string',
    Metadata='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

• Name (string) --

  [REQUIRED]

  The name of the AppInstance .

• Metadata (string) -- The metadata of the AppInstance . Limited to a 1KB string in UTF-8.
• ClientRequestToken (string) --

  [REQUIRED]

  The ClientRequestToken of the AppInstance .

  This field is autopopulated if not provided.

• Tags (list) --

  Tags assigned to the AppInstanceUser .

  • (dict) --

    A tag object containing a key-value pair.

    • Key (string) -- [REQUIRED]

      The key in a tag.

    • Value (string) -- [REQUIRED]

      The value in a tag.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string'
}

Response Structure

• (dict) --

  • AppInstanceArn (string) --

    The Amazon Resource Number (ARN) of 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