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'
        },
    ],
    ExpirationSettings={
        'ExpirationDays': 123,
        'ExpirationCriterion': 'CREATED_TIMESTAMP'
    }
)
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 unique ID of the request. Use different tokens to request additional AppInstances.

    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.

  • ExpirationSettings (dict) –

    Settings that control the interval after which the AppInstanceUser is automatically deleted.

    • ExpirationDays (integer) – [REQUIRED]

      The period in days after which an AppInstanceUser will be automatically deleted.

    • ExpirationCriterion (string) – [REQUIRED]

      Specifies the conditions under which an AppInstanceUser will expire.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceUserArn': 'string'
}

Response Structure

  • (dict) –

    • AppInstanceUserArn (string) –

      The user’s ARN.

Exceptions