ChimeSDKIdentity

Table of Contents

Client

class ChimeSDKIdentity.Client

A low-level client representing Amazon Chime SDK Identity

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to .

import boto3

client = boto3.client('chime-sdk-identity')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
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) --

      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

  • 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
create_app_instance_admin(**kwargs)

Promotes an AppInstanceUser to an AppInstanceAdmin . The promoted user can perform the following actions.

  • ChannelModerator actions across all channels in the AppInstance .
  • DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

See also: AWS API Documentation

Request Syntax

response = client.create_app_instance_admin(
    AppInstanceAdminArn='string',
    AppInstanceArn='string'
)
Parameters
  • AppInstanceAdminArn (string) --

    [REQUIRED]

    The ARN of the administrator of the current AppInstance .

  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the AppInstance .

Return type

dict

Returns

Response Syntax

{
    'AppInstanceAdmin': {
        'Arn': 'string',
        'Name': 'string'
    },
    'AppInstanceArn': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceAdmin (dict) --

      The name and ARN of the admin for the AppInstance .

      • Arn (string) --

        The ARN in an Identity.

      • Name (string) --

        The name in an Identity.

    • AppInstanceArn (string) --

      The ARN of the of the admin for 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
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) --

      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

  • 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
delete_app_instance(**kwargs)

Deletes an AppInstance and all associated data asynchronously.

See also: AWS API Documentation

Request Syntax

response = client.delete_app_instance(
    AppInstanceArn='string'
)
Parameters
AppInstanceArn (string) --

[REQUIRED]

The ARN of the AppInstance .

Returns
None

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
delete_app_instance_admin(**kwargs)

Demotes an AppInstanceAdmin to an AppInstanceUser . This action does not delete the user.

See also: AWS API Documentation

Request Syntax

response = client.delete_app_instance_admin(
    AppInstanceAdminArn='string',
    AppInstanceArn='string'
)
Parameters
  • AppInstanceAdminArn (string) --

    [REQUIRED]

    The ARN of the AppInstance 's administrator.

  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the AppInstance .

Returns

None

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
delete_app_instance_user(**kwargs)

Deletes an AppInstanceUser .

See also: AWS API Documentation

Request Syntax

response = client.delete_app_instance_user(
    AppInstanceUserArn='string'
)
Parameters
AppInstanceUserArn (string) --

[REQUIRED]

The ARN of the user request being deleted.

Returns
None

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
describe_app_instance(**kwargs)

Returns the full details of an AppInstance .

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance(
    AppInstanceArn='string'
)
Parameters
AppInstanceArn (string) --

[REQUIRED]

The ARN of the AppInstance .

Return type
dict
Returns
Response Syntax
{
    'AppInstance': {
        'AppInstanceArn': 'string',
        'Name': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'Metadata': 'string'
    }
}

Response Structure

  • (dict) --
    • AppInstance (dict) --

      The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance . All timestamps use epoch milliseconds.

      • AppInstanceArn (string) --

        The ARN of the messaging instance.

      • Name (string) --

        The name of an AppInstance .

      • CreatedTimestamp (datetime) --

        The time at which an AppInstance was created. In epoch milliseconds.

      • LastUpdatedTimestamp (datetime) --

        The time an AppInstance was last updated. In epoch milliseconds.

      • Metadata (string) --

        The metadata of an AppInstance .

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
describe_app_instance_admin(**kwargs)

Returns the full details of an AppInstanceAdmin .

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance_admin(
    AppInstanceAdminArn='string',
    AppInstanceArn='string'
)
Parameters
  • AppInstanceAdminArn (string) --

    [REQUIRED]

    The ARN of the AppInstanceAdmin .

  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the AppInstance .

Return type

dict

Returns

Response Syntax

{
    'AppInstanceAdmin': {
        'Admin': {
            'Arn': 'string',
            'Name': 'string'
        },
        'AppInstanceArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • AppInstanceAdmin (dict) --

      The ARN and name of the AppInstanceUser , the ARN of the AppInstance , and the created and last-updated timestamps. All timestamps use epoch milliseconds.

      • Admin (dict) --

        The AppInstanceAdmin data.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

      • AppInstanceArn (string) --

        The ARN of the AppInstance for which the user is an administrator.

      • CreatedTimestamp (datetime) --

        The time at which an administrator was created.

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
describe_app_instance_user(**kwargs)

Returns the full details of an AppInstanceUser .

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance_user(
    AppInstanceUserArn='string'
)
Parameters
AppInstanceUserArn (string) --

[REQUIRED]

The ARN of the AppInstanceUser .

Return type
dict
Returns
Response Syntax
{
    'AppInstanceUser': {
        'AppInstanceUserArn': 'string',
        'Name': 'string',
        'Metadata': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • AppInstanceUser (dict) --

      The name of the AppInstanceUser .

      • AppInstanceUserArn (string) --

        The ARN of the AppInstanceUser .

      • Name (string) --

        The name of the AppInstanceUser .

      • Metadata (string) --

        The metadata of the AppInstanceUser .

      • CreatedTimestamp (datetime) --

        The time at which the AppInstanceUser was created.

      • LastUpdatedTimestamp (datetime) --

        The time at which the AppInstanceUser was last updated.

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_app_instance_retention_settings(**kwargs)

Gets the retention settings for an AppInstance .

See also: AWS API Documentation

Request Syntax

response = client.get_app_instance_retention_settings(
    AppInstanceArn='string'
)
Parameters
AppInstanceArn (string) --

[REQUIRED]

The ARN of the AppInstance .

Return type
dict
Returns
Response Syntax
{
    'AppInstanceRetentionSettings': {
        'ChannelRetentionSettings': {
            'RetentionDays': 123
        }
    },
    'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • AppInstanceRetentionSettings (dict) --

      The retention settings for the AppInstance .

      • ChannelRetentionSettings (dict) --

        The length of time in days to retain the messages in a channel.

        • RetentionDays (integer) --

          The time in days to retain the messages in a channel.

    • InitiateDeletionTimestamp (datetime) --

      The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_app_instance_admins(**kwargs)

Returns a list of the administrators in the AppInstance .

See also: AWS API Documentation

Request Syntax

response = client.list_app_instance_admins(
    AppInstanceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the AppInstance .

  • MaxResults (integer) -- The maximum number of administrators that you want to return.
  • NextToken (string) -- The token returned from previous API requests until the number of administrators is reached.
Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string',
    'AppInstanceAdmins': [
        {
            'Admin': {
                'Arn': 'string',
                'Name': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceArn (string) --

      The ARN of the AppInstance .

    • AppInstanceAdmins (list) --

      The information for each administrator.

      • (dict) --

        Summary of the details of an AppInstanceAdmin .

        • Admin (dict) --

          The details of the AppInstanceAdmin .

          • Arn (string) --

            The ARN in an Identity.

          • Name (string) --

            The name in an Identity.

    • NextToken (string) --

      The token returned from previous API requests until the number of administrators is reached.

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
list_app_instance_users(**kwargs)

List all AppInstanceUsers created under a single AppInstance .

See also: AWS API Documentation

Request Syntax

response = client.list_app_instance_users(
    AppInstanceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the AppInstance .

  • MaxResults (integer) -- The maximum number of requests that you want returned.
  • NextToken (string) -- The token passed by previous API calls until all requested users are returned.
Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string',
    'AppInstanceUsers': [
        {
            'AppInstanceUserArn': 'string',
            'Name': 'string',
            'Metadata': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceArn (string) --

      The ARN of the AppInstance .

    • AppInstanceUsers (list) --

      The information for each requested AppInstanceUser .

      • (dict) --

        Summary of the details of an AppInstanceUser .

        • AppInstanceUserArn (string) --

          The ARN of the AppInstanceUser .

        • Name (string) --

          The name of an AppInstanceUser .

        • Metadata (string) --

          The metadata of the AppInstanceUser .

    • NextToken (string) --

      The token passed by previous API calls until all requested users are returned.

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
list_app_instances(**kwargs)

Lists all Amazon Chime AppInstance s created under a single AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_app_instances(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of AppInstance s that you want to return.
  • NextToken (string) -- The token passed by previous API requests until you reach the maximum number of AppInstances .
Return type

dict

Returns

Response Syntax

{
    'AppInstances': [
        {
            'AppInstanceArn': 'string',
            'Name': 'string',
            'Metadata': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AppInstances (list) --

      The information for each AppInstance .

      • (dict) --

        Summary of the data for an AppInstance .

        • AppInstanceArn (string) --

          The AppInstance ARN.

        • Name (string) --

          The name of the AppInstance .

        • Metadata (string) --

          The metadata of the AppInstance .

    • NextToken (string) --

      The token passed by previous API requests until the maximum number of AppInstance s is reached.

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
put_app_instance_retention_settings(**kwargs)

Sets the amount of time in days that a given AppInstance retains data.

See also: AWS API Documentation

Request Syntax

response = client.put_app_instance_retention_settings(
    AppInstanceArn='string',
    AppInstanceRetentionSettings={
        'ChannelRetentionSettings': {
            'RetentionDays': 123
        }
    }
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the AppInstance .

  • AppInstanceRetentionSettings (dict) --

    [REQUIRED]

    The time in days to retain data. Data type: number.

    • ChannelRetentionSettings (dict) --

      The length of time in days to retain the messages in a channel.

      • RetentionDays (integer) --

        The time in days to retain the messages in a channel.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceRetentionSettings': {
        'ChannelRetentionSettings': {
            'RetentionDays': 123
        }
    },
    'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • AppInstanceRetentionSettings (dict) --

      The time in days to retain data. Data type: number.

      • ChannelRetentionSettings (dict) --

        The length of time in days to retain the messages in a channel.

        • RetentionDays (integer) --

          The time in days to retain the messages in a channel.

    • InitiateDeletionTimestamp (datetime) --

      The time at which the API deletes data.

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
update_app_instance(**kwargs)

Updates AppInstance metadata.

See also: AWS API Documentation

Request Syntax

response = client.update_app_instance(
    AppInstanceArn='string',
    Name='string',
    Metadata='string'
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the AppInstance .

  • Name (string) --

    [REQUIRED]

    The name that you want to change.

  • Metadata (string) --

    [REQUIRED]

    The metadata that you want to change.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceArn (string) --

      The ARN of the AppInstance .

Exceptions

  • ChimeSDKIdentity.Client.exceptions.BadRequestException
  • ChimeSDKIdentity.Client.exceptions.ConflictException
  • ChimeSDKIdentity.Client.exceptions.ForbiddenException
  • ChimeSDKIdentity.Client.exceptions.ThrottledClientException
  • ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
  • ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
  • ChimeSDKIdentity.Client.exceptions.ServiceFailureException
update_app_instance_user(**kwargs)

Updates the details of an AppInstanceUser . You can update names and metadata.

See also: AWS API Documentation

Request Syntax

response = client.update_app_instance_user(
    AppInstanceUserArn='string',
    Name='string',
    Metadata='string'
)
Parameters
  • AppInstanceUserArn (string) --

    [REQUIRED]

    The ARN of the AppInstanceUser .

  • Name (string) --

    [REQUIRED]

    The name of the AppInstanceUser .

  • Metadata (string) --

    [REQUIRED]

    The metadata of the AppInstanceUser .

Return type

dict

Returns

Response Syntax

{
    'AppInstanceUserArn': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceUserArn (string) --

      The ARN of the AppInstanceUser .

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

Paginators

The available paginators are: