ChimeSDKIdentity / Client / create_app_instance_user

create_app_instance_user

ChimeSDKIdentity.Client.create_app_instance_user(**kwargs)

Creates a user under an Amazon Chime AppInstance . The request consists of a unique appInstanceUserId and Name for that user.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• AppInstanceArn (string) –

  [REQUIRED]

  The ARN of the AppInstance request.

• AppInstanceUserId (string) –

  [REQUIRED]

  The user ID of the AppInstance .

• Name (string) –

  [REQUIRED]

  The user’s name.

• Metadata (string) – The request’s metadata. Limited to a 1KB string in UTF-8.

• ClientRequestToken (string) –

  [REQUIRED]

  The token assigned to the user requesting an 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

{
    'AppInstanceUserArn': 'string'
}

Response Structure

• (dict) –

  • AppInstanceUserArn (string) –

    The user’s ARN.

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