Table of Contents
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 Amazon Chime SDK identity.
import boto3
client = boto3.client('chime-sdk-identity')
These are the available methods:
can_paginate()close()create_app_instance()create_app_instance_admin()create_app_instance_user()delete_app_instance()delete_app_instance_admin()delete_app_instance_user()deregister_app_instance_user_endpoint()describe_app_instance()describe_app_instance_admin()describe_app_instance_user()describe_app_instance_user_endpoint()get_app_instance_retention_settings()get_paginator()get_waiter()list_app_instance_admins()list_app_instance_user_endpoints()list_app_instance_users()list_app_instances()list_tags_for_resource()put_app_instance_retention_settings()register_app_instance_user_endpoint()tag_resource()untag_resource()update_app_instance()update_app_instance_user()update_app_instance_user_endpoint()can_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
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'
},
]
)
[REQUIRED]
The name of the AppInstance .
AppInstance . Limited to a 1KB string in UTF-8.[REQUIRED]
The ClientRequestToken of the AppInstance .
This field is autopopulated if not provided.
Tags assigned to the AppInstanceUser .
A tag object containing a key-value pair.
The key in a tag.
The value in a tag.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The Amazon Resource Number (ARN) of the AppInstance .
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptioncreate_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'
)
[REQUIRED]
The ARN of the administrator of the current AppInstance .
[REQUIRED]
The ARN of the AppInstance .
dict
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.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptioncreate_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'
},
]
)
[REQUIRED]
The ARN of the AppInstance request.
[REQUIRED]
The user ID of the AppInstance .
[REQUIRED]
The user's name.
[REQUIRED]
The token assigned to the user requesting an AppInstance .
This field is autopopulated if not provided.
Tags assigned to the AppInstanceUser .
A tag object containing a key-value pair.
The key in a tag.
The value in a tag.
dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The user's ARN.
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptiondelete_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'
)
[REQUIRED]
The ARN of the AppInstance .
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptiondelete_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'
)
[REQUIRED]
The ARN of the AppInstance 's administrator.
[REQUIRED]
The ARN of the AppInstance .
None
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptiondelete_app_instance_user(**kwargs)¶Deletes an AppInstanceUser .
See also: AWS API Documentation
Request Syntax
response = client.delete_app_instance_user(
AppInstanceUserArn='string'
)
[REQUIRED]
The ARN of the user request being deleted.
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionderegister_app_instance_user_endpoint(**kwargs)¶Deregisters an AppInstanceUserEndpoint .
See also: AWS API Documentation
Request Syntax
response = client.deregister_app_instance_user_endpoint(
AppInstanceUserArn='string',
EndpointId='string'
)
[REQUIRED]
The ARN of the AppInstanceUser .
[REQUIRED]
The unique identifier of the AppInstanceUserEndpoint .
None
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptiondescribe_app_instance(**kwargs)¶Returns the full details of an AppInstance .
See also: AWS API Documentation
Request Syntax
response = client.describe_app_instance(
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the AppInstance .
{
'AppInstance': {
'AppInstanceArn': 'string',
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'Metadata': 'string'
}
}
Response Structure
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance . All timestamps use epoch milliseconds.
The ARN of the messaging instance.
The name of an AppInstance .
The time at which an AppInstance was created. In epoch milliseconds.
The time an AppInstance was last updated. In epoch milliseconds.
The metadata of an AppInstance .
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptiondescribe_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'
)
[REQUIRED]
The ARN of the AppInstanceAdmin .
[REQUIRED]
The ARN of the AppInstance .
dict
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.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptiondescribe_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'
)
[REQUIRED]
The ARN of the AppInstanceUser .
{
'AppInstanceUser': {
'AppInstanceUserArn': 'string',
'Name': 'string',
'Metadata': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The name of the AppInstanceUser .
The ARN of the AppInstanceUser .
The name of the AppInstanceUser .
The metadata of the AppInstanceUser .
The time at which the AppInstanceUser was created.
The time at which the AppInstanceUser was last updated.
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptiondescribe_app_instance_user_endpoint(**kwargs)¶Returns the full details of an AppInstanceUserEndpoint .
See also: AWS API Documentation
Request Syntax
response = client.describe_app_instance_user_endpoint(
AppInstanceUserArn='string',
EndpointId='string'
)
[REQUIRED]
The ARN of the AppInstanceUser .
[REQUIRED]
The unique identifier of the AppInstanceUserEndpoint .
dict
Response Syntax
{
'AppInstanceUserEndpoint': {
'AppInstanceUserArn': 'string',
'EndpointId': 'string',
'Name': 'string',
'Type': 'APNS'|'APNS_SANDBOX'|'GCM',
'ResourceArn': 'string',
'EndpointAttributes': {
'DeviceToken': 'string',
'VoipDeviceToken': 'string'
},
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'AllowMessages': 'ALL'|'NONE',
'EndpointState': {
'Status': 'ACTIVE'|'INACTIVE',
'StatusReason': 'INVALID_DEVICE_TOKEN'|'INVALID_PINPOINT_ARN'
}
}
}
Response Structure
(dict) --
AppInstanceUserEndpoint (dict) --
The full details of an AppInstanceUserEndpoint : the AppInstanceUserArn , ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser .
EndpointId (string) --
The unique identifier of the AppInstanceUserEndpoint .
Name (string) --
The name of the AppInstanceUserEndpoint .
Type (string) --
The type of the AppInstanceUserEndpoint .
ResourceArn (string) --
The ARN of the resource to which the endpoint belongs.
EndpointAttributes (dict) --
The attributes of an Endpoint .
DeviceToken (string) --
The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
VoipDeviceToken (string) --
The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
CreatedTimestamp (datetime) --
The time at which an AppInstanceUserEndpoint was created.
LastUpdatedTimestamp (datetime) --
The time at which an AppInstanceUserEndpoint was last updated.
AllowMessages (string) --
Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
EndpointState (dict) --
A read-only field that represents the state of an AppInstanceUserEndpoint . Supported values:
ACTIVE : The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE , the EndpointStatusReason remains empty.INACTIVE : The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE , the corresponding reason will be conveyed through EndpointStatusReason .INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device tokenINVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.Status (string) --
Enum that indicates the Status of an AppInstanceUserEndpoint .
StatusReason (string) --
The reason for the EndpointStatus .
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionget_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'
)
[REQUIRED]
The ARN of the AppInstance .
{
'AppInstanceRetentionSettings': {
'ChannelRetentionSettings': {
'RetentionDays': 123
}
},
'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}
Response Structure
The retention settings for the AppInstance .
The length of time in days to retain the messages in a channel.
The time in days to retain the messages in a channel.
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
[REQUIRED]
The ARN of the AppInstance .
dict
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.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionlist_app_instance_user_endpoints(**kwargs)¶Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser .
See also: AWS API Documentation
Request Syntax
response = client.list_app_instance_user_endpoints(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the AppInstanceUser .
dict
Response Syntax
{
'AppInstanceUserEndpoints': [
{
'AppInstanceUserArn': 'string',
'EndpointId': 'string',
'Name': 'string',
'Type': 'APNS'|'APNS_SANDBOX'|'GCM',
'AllowMessages': 'ALL'|'NONE',
'EndpointState': {
'Status': 'ACTIVE'|'INACTIVE',
'StatusReason': 'INVALID_DEVICE_TOKEN'|'INVALID_PINPOINT_ARN'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstanceUserEndpoints (list) --
The information for each requested AppInstanceUserEndpoint .
(dict) --
Summary of the details of an AppInstanceUserEndpoint .
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser .
EndpointId (string) --
The unique identifier of the AppInstanceUserEndpoint .
Name (string) --
The name of the AppInstanceUserEndpoint .
Type (string) --
The type of the AppInstanceUserEndpoint .
AllowMessages (string) --
BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.
EndpointState (dict) --
A read-only field that represent the state of an AppInstanceUserEndpoint .
Status (string) --
Enum that indicates the Status of an AppInstanceUserEndpoint .
StatusReason (string) --
The reason for the EndpointStatus .
NextToken (string) --
The token passed by previous API calls until all requested endpoints are returned.
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionlist_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'
)
[REQUIRED]
The ARN of the AppInstance .
dict
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.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionlist_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'
)
AppInstance s that you want to return.AppInstances .dict
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.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionLists the tags applied to an Amazon Chime SDK identity resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The ARN of the resource.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tag key-value pairs.
A tag object containing a key-value pair.
The key in a tag.
The value in a tag.
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionput_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
}
}
)
[REQUIRED]
The ARN of the AppInstance .
[REQUIRED]
The time in days to retain data. Data type: number.
The length of time in days to retain the messages in a channel.
The time in days to retain the messages in a channel.
dict
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.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionregister_app_instance_user_endpoint(**kwargs)¶Registers an endpoint under an Amazon Chime AppInstanceUser . The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.
See also: AWS API Documentation
Request Syntax
response = client.register_app_instance_user_endpoint(
AppInstanceUserArn='string',
Name='string',
Type='APNS'|'APNS_SANDBOX'|'GCM',
ResourceArn='string',
EndpointAttributes={
'DeviceToken': 'string',
'VoipDeviceToken': 'string'
},
ClientRequestToken='string',
AllowMessages='ALL'|'NONE'
)
[REQUIRED]
The ARN of the AppInstanceUser .
AppInstanceUserEndpoint .[REQUIRED]
The type of the AppInstanceUserEndpoint . Supported types:
APNS : The mobile notification service for an Apple device.APNS_SANDBOX : The sandbox environment of the mobile notification service for an Apple device.GCM : The mobile notification service for an Android device.Populate the ResourceArn value of each type as PinpointAppArn .
[REQUIRED]
The ARN of the resource to which the endpoint belongs.
[REQUIRED]
The attributes of an Endpoint .
The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
[REQUIRED]
The idempotency token for each client request.
This field is autopopulated if not provided.
ALL indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.dict
Response Syntax
{
'AppInstanceUserArn': 'string',
'EndpointId': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser .
EndpointId (string) --
The unique identifier of the AppInstanceUserEndpoint .
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptiontag_resource(**kwargs)¶Applies the specified tags to the specified Amazon Chime SDK identity resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The resource ARN.
[REQUIRED]
The tag key-value pairs.
A tag object containing a key-value pair.
The key in a tag.
The value in a tag.
None
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionuntag_resource(**kwargs)¶Removes the specified tags from the specified Amazon Chime SDK identity resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The resource ARN.
[REQUIRED]
The tag keys.
None
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionupdate_app_instance(**kwargs)¶Updates AppInstance metadata.
See also: AWS API Documentation
Request Syntax
response = client.update_app_instance(
AppInstanceArn='string',
Name='string',
Metadata='string'
)
[REQUIRED]
The ARN of the AppInstance .
[REQUIRED]
The name that you want to change.
[REQUIRED]
The metadata that you want to change.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the AppInstance .
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionupdate_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'
)
[REQUIRED]
The ARN of the AppInstanceUser .
[REQUIRED]
The name of the AppInstanceUser .
[REQUIRED]
The metadata of the AppInstanceUser .
dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser .
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionupdate_app_instance_user_endpoint(**kwargs)¶Updates the details of an AppInstanceUserEndpoint . You can update the name and AllowMessage values.
See also: AWS API Documentation
Request Syntax
response = client.update_app_instance_user_endpoint(
AppInstanceUserArn='string',
EndpointId='string',
Name='string',
AllowMessages='ALL'|'NONE'
)
[REQUIRED]
The ARN of the AppInstanceUser .
[REQUIRED]
The unique identifier of the AppInstanceUserEndpoint .
AppInstanceUserEndpoint .AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.dict
Response Syntax
{
'AppInstanceUserArn': 'string',
'EndpointId': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser .
EndpointId (string) --
The unique identifier of the AppInstanceUserEndpoint .
Exceptions
ChimeSDKIdentity.Client.exceptions.BadRequestExceptionChimeSDKIdentity.Client.exceptions.ConflictExceptionChimeSDKIdentity.Client.exceptions.ForbiddenExceptionChimeSDKIdentity.Client.exceptions.ThrottledClientExceptionChimeSDKIdentity.Client.exceptions.UnauthorizedClientExceptionChimeSDKIdentity.Client.exceptions.ServiceUnavailableExceptionChimeSDKIdentity.Client.exceptions.ServiceFailureExceptionThe available paginators are: