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.

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 AppInstance .

  • (dict) --

    Describes a tag applied to a resource.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) -- [REQUIRED]

      The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string'
}

Response Structure

• (dict) --

  • AppInstanceArn (string) --

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