Table of Contents
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:
Check if an operation can be paginated.
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 .
[REQUIRED]
The ClientRequestToken of the AppInstance .
This field is autopopulated if not provided.
Tags assigned to the AppInstanceUser .
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The Amazon Resource Number (ARN) of the AppInstance .
Exceptions
Promotes an AppInstanceUser to an AppInstanceAdmin . The promoted user can perform the following 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
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 .
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The user's ARN.
Exceptions
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
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
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
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
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
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
Generate a presigned url given a client, its method, and arguments
The presigned url
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
Create a paginator for an operation.
Returns an object that can wait for some condition.
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
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
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'
)
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
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
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
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
The available paginators are: