Chime / Client / create_app_instance_user

create_app_instance_user#

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

Warning

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

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_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) –

      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

{
    'AppInstanceUserArn': 'string'
}

Response Structure

  • (dict) –

    • AppInstanceUserArn (string) –

      The user’s ARN.

Exceptions