2020/11/20 - Amazon Chime - 48 new api methods
Changes The Amazon Chime SDK for messaging provides the building blocks needed to build chat and other real-time collaboration features.
Update a channel's attributes.
Restriction : You can't change a channel's privacy.
See also: AWS API Documentation
Request Syntax
client.update_channel(
ChannelArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Metadata='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The name of the channel.
string
[REQUIRED]
The mode of the update request.
string
The metadata of the channel.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Gets the full details of a channel message.
See also: AWS API Documentation
Request Syntax
client.get_channel_message(
ChannelArn='string',
MessageId='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ID of the message.
dict
Response Syntax
{
'ChannelMessage': {
'ChannelArn': 'string',
'MessageId': 'string',
'Content': 'string',
'Metadata': 'string',
'Type': 'STANDARD'|'CONTROL',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastEditedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'Sender': {
'Arn': 'string',
'Name': 'string'
},
'Redacted': True|False,
'Persistence': 'PERSISTENT'|'NON_PERSISTENT'
}
}
Response Structure
(dict) --
ChannelMessage (dict) --
The details of and content in the message.
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID of a message.
Content (string) --
The message content.
Metadata (string) --
The message metadata.
Type (string) --
The message type.
CreatedTimestamp (datetime) --
The time at which the message was created.
LastEditedTimestamp (datetime) --
The time at which a message was edited.
LastUpdatedTimestamp (datetime) --
The time at which a message was updated.
Sender (dict) --
The message sender.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Redacted (boolean) --
Hides the content of a message. The message still exists on the back end, but this action only returns metadata.
Persistence (string) --
Lists all Amazon Chime app instances created under a single AWS account.
See also: AWS API Documentation
Request Syntax
client.list_app_instances(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of app instances that you want to return.
string
The token passed by previous API requests until you reach the maximum number of app instances.
dict
Response Syntax
{
'AppInstances': [
{
'AppInstanceArn': 'string',
'Name': 'string',
'Metadata': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstances (list) --
The information for each app instance.
(dict) --
The summary data for an app instance.
AppInstanceArn (string) --
The app instance ARN.
Name (string) --
The name of the app instance summary.
Metadata (string) --
The metadata of the app instance summary.
NextToken (string) --
The token passed by previous API requests until the maximum number of app instances is reached.
Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan , and then CreateChannelMembership . Bans are cleaned up when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
See also: AWS API Documentation
Request Syntax
client.create_channel_ban(
ChannelArn='string',
MemberArn='string'
)
string
[REQUIRED]
The ARN of the ban request.
string
[REQUIRED]
The ARN of the member being banned.
dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the response to the ban request.
Member (dict) --
The ChannelArn and BannedIdentity of the member in the ban response.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
List all the messages in a channel. Returns a paginated list of ChannelMessages . Sorted in descending order by default, based on the creation timestamp.
Note
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
See also: AWS API Documentation
Request Syntax
client.list_channel_messages(
ChannelArn='string',
SortOrder='ASCENDING'|'DESCENDING',
NotBefore=datetime(2015, 1, 1),
NotAfter=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the channel.
string
The order in which you want messages sorted. Default is Descending, based on time created.
datetime
The initial or starting time stamp for your requested messages.
datetime
The final or ending time stamp for your requested messages.
integer
The maximum number of messages that you want returned.
string
The token passed by previous API calls until all requested messages are returned.
dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelMessages': [
{
'MessageId': 'string',
'Content': 'string',
'Metadata': 'string',
'Type': 'STANDARD'|'CONTROL',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'LastEditedTimestamp': datetime(2015, 1, 1),
'Sender': {
'Arn': 'string',
'Name': 'string'
},
'Redacted': True|False
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel containing the requested messages.
NextToken (string) --
The token passed by previous API calls until all requested messages are returned.
ChannelMessages (list) --
The information about and content of each requested message.
(dict) --
A summary of the messages in a channel.
MessageId (string) --
The ID of the message summary.
Content (string) --
The content of the message summary.
Metadata (string) --
The metadata of the message summary.
Type (string) --
The type of message summary.
CreatedTimestamp (datetime) --
The time at which the message summary was created.
LastUpdatedTimestamp (datetime) --
LastEditedTimestamp (datetime) --
Sender (dict) --
The sender of the message summary.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Redacted (boolean) --
Redacts the content of a message summary.
Deletes an AppInstance and all associated data asynchronously.
See also: AWS API Documentation
Request Syntax
client.delete_app_instance(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the app instance.
None
Updates AppInstance metadata.
See also: AWS API Documentation
Request Syntax
client.update_app_instance(
AppInstanceArn='string',
Name='string',
Metadata='string'
)
string
[REQUIRED]
The ARN of the app instance.
string
[REQUIRED]
The name that you want to change.
string
The metadata that you want to change.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the app instance.
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
See also: AWS API Documentation
Request Syntax
client.redact_channel_message(
ChannelArn='string',
MessageId='string'
)
string
[REQUIRED]
The ARN of the channel containing the messages that you want to redact.
string
[REQUIRED]
The ID of the message being redacted.
dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel containing the messages that you want to redact.
MessageId (string) --
The ID of the message being redacted.
Sets the timestamp to the point when a user last read messages in a channel.
See also: AWS API Documentation
Request Syntax
client.update_channel_read_marker(
ChannelArn='string'
)
string
[REQUIRED]
The ARN of the channel.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Returns the full details of a channel moderated by the specified AppInstanceUser .
See also: AWS API Documentation
Request Syntax
client.describe_channel_moderated_by_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string'
)
string
[REQUIRED]
The ARN of the moderated channel.
string
[REQUIRED]
The ARN of the app instance user in the moderated channel.
dict
Response Syntax
{
'Channel': {
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Channel (dict) --
The moderated channel.
ChannelSummary (dict) --
The summary data for a channel.
Name (string) --
The parameter of the action.
ChannelArn (string) --
The ARN of the channel summary.
Mode (string) --
The summary mode of the channel.
Privacy (string) --
The privacy setting of the channel being summarized, PUBLIC or HIDDEN .
Metadata (string) --
The metadata of the channel summary.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage .
See also: AWS API Documentation
Request Syntax
client.delete_channel_message(
ChannelArn='string',
MessageId='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ID of the message being deleted.
None
Lists all the users banned from a particular channel.
See also: AWS API Documentation
Request Syntax
client.list_channel_bans(
ChannelArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the channel.
integer
The maximum number of bans that you want returned.
string
The token passed by previous API calls until all requested bans are returned.
dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelBans': [
{
'Member': {
'Arn': 'string',
'Name': 'string'
}
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
NextToken (string) --
The token passed by previous API calls until all requested bans are returned.
ChannelBans (list) --
The information for each requested ban.
(dict) --
The summary data for the channel ban.
Member (dict) --
The member being banned from a channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Sends a message to a particular channel that the member is a part of.
Note
STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.
See also: AWS API Documentation
Request Syntax
client.send_channel_message(
ChannelArn='string',
Content='string',
Type='STANDARD'|'CONTROL',
Persistence='PERSISTENT'|'NON_PERSISTENT',
Metadata='string',
ClientRequestToken='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The content of the message.
string
[REQUIRED]
The type of message, STANDARD or CONTROL .
string
[REQUIRED]
Boolean that controls whether the message is persisted on the back end. Required.
string
The optional metadata for each message.
string
[REQUIRED]
The Idempotency token for each client request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID string assigned to each message.
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
client.create_app_instance_user(
AppInstanceArn='string',
AppInstanceUserId='string',
Name='string',
Metadata='string',
ClientRequestToken='string'
)
string
[REQUIRED]
The ARN of the app instance request.
string
[REQUIRED]
The user ID of the app instance.
string
[REQUIRED]
The user's name.
string
The request's metadata. Limited to a 1KB string in UTF-8.
string
[REQUIRED]
The token assigned to the user requesting an app instance.
This field is autopopulated if not provided.
dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The user's ARN.
Returns the full details of a channel in an Amazon Chime app instance.
See also: AWS API Documentation
Request Syntax
client.describe_channel(
ChannelArn='string'
)
string
[REQUIRED]
The ARN of the channel.
dict
Response Syntax
{
'Channel': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
},
'CreatedTimestamp': datetime(2015, 1, 1),
'LastMessageTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Channel (dict) --
The channel details.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The channel's privacy setting, PUBLIC or HIDDEN .
Metadata (string) --
The metadata of the channel.
CreatedBy (dict) --
The administrator who created the channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
CreatedTimestamp (datetime) --
The time at which the administrator created the channel.
LastMessageTimestamp (datetime) --
The time at which a member sent the last message in a session.
LastUpdatedTimestamp (datetime) --
The time at which a channel was last updated.
Returns the full details of an AppInstance .
See also: AWS API Documentation
Request Syntax
client.describe_app_instance(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the app instance.
dict
Response Syntax
{
'AppInstance': {
'AppInstanceArn': 'string',
'Name': 'string',
'Metadata': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AppInstance (dict) --
The ARN, metadata, created and last-updated timestamps, and the name of the app instance. All timestamps use epoch milliseconds.
AppInstanceArn (string) --
The ARN of the messaging instance.
Name (string) --
The name of an app instance.
Metadata (string) --
The metadata of an app instance.
CreatedTimestamp (datetime) --
The time at which an app instance was created. In epoch milliseconds.
LastUpdatedTimestamp (datetime) --
The time an app instance was last updated. In epoch milliseconds.
Returns the full details of an AppInstanceUser .
See also: AWS API Documentation
Request Syntax
client.describe_app_instance_user(
AppInstanceUserArn='string'
)
string
[REQUIRED]
The ARN of the app instance user.
dict
Response Syntax
{
'AppInstanceUser': {
'AppInstanceUserArn': 'string',
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'Metadata': 'string',
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AppInstanceUser (dict) --
The name of the app instance user.
AppInstanceUserArn (string) --
The ARN of the app instance user.
Name (string) --
The name of the app instance user.
CreatedTimestamp (datetime) --
The time at which the app instance user was created.
Metadata (string) --
The metadata of the app instance user.
LastUpdatedTimestamp (datetime) --
The time at which the app instance user was last updated.
Returns the full details of a single ChannelModerator.
See also: AWS API Documentation
Request Syntax
client.describe_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ARN of the channel moderator.
dict
Response Syntax
{
'ChannelModerator': {
'Moderator': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
}
}
}
Response Structure
(dict) --
ChannelModerator (dict) --
The details of the channel moderator.
Moderator (dict) --
The moderator's data.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the moderator's channel.
CreatedTimestamp (datetime) --
The time at which the moderator was created.
CreatedBy (dict) --
The member who created the moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Updates the content of a message.
See also: AWS API Documentation
Request Syntax
client.update_channel_message(
ChannelArn='string',
MessageId='string',
Content='string',
Metadata='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ID string of the message being updated.
string
The content of the message being updated.
string
The metadata of the message being updated.
dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID string of the message being updated.
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.
See also: AWS API Documentation
Request Syntax
client.list_channels(
AppInstanceArn='string',
Privacy='PUBLIC'|'PRIVATE',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the app instance.
string
The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an app instance administrator can retrieve private channels.
integer
The maximum number of channels that you want to return.
string
The token passed by previous API calls until all requested channels are returned.
dict
Response Syntax
{
'Channels': [
{
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Channels (list) --
The information about each channel.
(dict) --
The summary data for a channel.
Name (string) --
The parameter of the action.
ChannelArn (string) --
The ARN of the channel summary.
Mode (string) --
The summary mode of the channel.
Privacy (string) --
The privacy setting of the channel being summarized, PUBLIC or HIDDEN .
Metadata (string) --
The metadata of the channel summary.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
NextToken (string) --
The token returned from previous API requests until the number of channels is reached.
Gets the streaming settings for an app instance.
See also: AWS API Documentation
Request Syntax
client.get_app_instance_streaming_configurations(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the app instance.
dict
Response Syntax
{
'AppInstanceStreamingConfigurations': [
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) --
AppInstanceStreamingConfigurations (list) --
The streaming settings.
(dict) --
The streaming configuration of an app instance.
AppInstanceDataType (string) --
The data type of the app instance.
ResourceArn (string) --
The resource ARN.
The data streaming configurations of an app instance.
See also: AWS API Documentation
Request Syntax
client.put_app_instance_streaming_configurations(
AppInstanceArn='string',
AppInstanceStreamingConfigurations=[
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
)
string
[REQUIRED]
The ARN of the app instance.
list
[REQUIRED]
The streaming configurations set for an app instance.
(dict) --
The streaming configuration of an app instance.
AppInstanceDataType (string) -- [REQUIRED]
The data type of the app instance.
ResourceArn (string) -- [REQUIRED]
The resource ARN.
dict
Response Syntax
{
'AppInstanceStreamingConfigurations': [
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) --
AppInstanceStreamingConfigurations (list) --
The streaming configurations of an app instance.
(dict) --
The streaming configuration of an app instance.
AppInstanceDataType (string) --
The data type of the app instance.
ResourceArn (string) --
The resource ARN.
Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.
See also: AWS API Documentation
Request Syntax
client.list_channel_memberships_for_app_instance_user(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string'
)
string
The ARN of the app instance users
integer
The maximum number of users that you want returned.
string
The token returned from previous API requests until the number of channel memberships is reached.
dict
Response Syntax
{
'ChannelMemberships': [
{
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
'AppInstanceUserMembershipSummary': {
'Type': 'DEFAULT'|'HIDDEN',
'ReadMarkerTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelMemberships (list) --
The token passed by previous API calls until all requested users are returned.
(dict) --
Returns the channel membership summary data for an app instance.
ChannelSummary (dict) --
The summary data for a channel.
Name (string) --
The parameter of the action.
ChannelArn (string) --
The ARN of the channel summary.
Mode (string) --
The summary mode of the channel.
Privacy (string) --
The privacy setting of the channel being summarized, PUBLIC or HIDDEN .
Metadata (string) --
The metadata of the channel summary.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
AppInstanceUserMembershipSummary (dict) --
Returns the channel membership data for an app instance.
Type (string) --
The type of channel summary,
ReadMarkerTimestamp (datetime) --
The time at which a summary was last read.
NextToken (string) --
The token passed by previous API calls until all requested users are returned.
Removes a user from a channel's ban list.
See also: AWS API Documentation
Request Syntax
client.delete_channel_ban(
ChannelArn='string',
MemberArn='string'
)
string
[REQUIRED]
The ARN of the channel from which the app instance user was banned.
string
[REQUIRED]
The ARN of the app instance user that you want to reinstate.
None
Returns the details of a channel based on the membership of the AppInstanceUser specified.
See also: AWS API Documentation
Request Syntax
client.describe_channel_membership_for_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string'
)
string
[REQUIRED]
The ARN of the channel to which the user belongs.
string
[REQUIRED]
The ARN of the user in a channel.
dict
Response Syntax
{
'ChannelMembership': {
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
'AppInstanceUserMembershipSummary': {
'Type': 'DEFAULT'|'HIDDEN',
'ReadMarkerTimestamp': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
ChannelMembership (dict) --
The channel to which a user belongs.
ChannelSummary (dict) --
The summary data for a channel.
Name (string) --
The parameter of the action.
ChannelArn (string) --
The ARN of the channel summary.
Mode (string) --
The summary mode of the channel.
Privacy (string) --
The privacy setting of the channel being summarized, PUBLIC or HIDDEN .
Metadata (string) --
The metadata of the channel summary.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
AppInstanceUserMembershipSummary (dict) --
Returns the channel membership data for an app instance.
Type (string) --
The type of channel summary,
ReadMarkerTimestamp (datetime) --
The time at which a summary was last read.
Promotes an AppInstanceUser to an AppInstanceAdmin . The promoted user can perform the following actions.
ChannelModerator actions across all channels in the app instance.
DeleteChannelMessage actions.
Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
See also: AWS API Documentation
Request Syntax
client.create_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the administrator of the current app instance.
string
[REQUIRED]
The ARN of the app instance.
dict
Response Syntax
{
'AppInstanceAdmin': {
'Arn': 'string',
'Name': 'string'
},
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceAdmin (dict) --
The name and ARN of the admin for the app instance.
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 app instance.
Deletes the streaming configurations of an app instance.
See also: AWS API Documentation
Request Syntax
client.delete_app_instance_streaming_configurations(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the streaming configurations being deleted.
None
Returns the full details of a user's channel membership.
See also: AWS API Documentation
Request Syntax
client.describe_channel_membership(
ChannelArn='string',
MemberArn='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ARN of the member.
dict
Response Syntax
{
'ChannelMembership': {
'InvitedBy': {
'Arn': 'string',
'Name': 'string'
},
'Type': 'DEFAULT'|'HIDDEN',
'Member': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ChannelMembership (dict) --
The details of the membership.
InvitedBy (dict) --
The identifier of the member who invited another member. Taken from the message header.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Type (string) --
The membership type set for the channel member.
Member (dict) --
The data of the channel member.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the member's channel.
CreatedTimestamp (datetime) --
The time at which the channel membership was created.
LastUpdatedTimestamp (datetime) --
The time at which a channel membership was last updated.
Returns a list of the administrators in the app instance.
See also: AWS API Documentation
Request Syntax
client.list_app_instance_admins(
AppInstanceArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the app instance.
integer
The maximum number of administrators that you want to return.
string
The token returned from previous API requests until the number of administrators is reached.
dict
Response Syntax
{
'AppInstanceArn': 'string',
'AppInstanceAdmins': [
{
'Admin': {
'Arn': 'string',
'Name': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the app instance.
AppInstanceAdmins (list) --
The information for each administrator.
(dict) --
The identity and metadata of an administrator.
Admin (dict) --
The name and metadata of the app instance administrator.
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.
Sets the amount of time in days that a given app instance retains data.
See also: AWS API Documentation
Request Syntax
client.put_app_instance_retention_settings(
AppInstanceArn='string',
AppInstanceRetentionSettings={
'ChannelRetentionSettings': {
'RetentionDays': 123
}
}
)
string
[REQUIRED]
The ARN of the app instance.
dict
[REQUIRED]
The time in days to retain data. Data type: number.
ChannelRetentionSettings (dict) --
The length of time in days to retain a channel.
RetentionDays (integer) --
The time in days to retain 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 a channel.
RetentionDays (integer) --
The time in days to retain a channel.
InitiateDeletionTimestamp (datetime) --
The time at which the API deletes data.
Creates an Amazon Chime Messaging SDK AppInstance under an AWS Account. Only Messaging SDK customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.
See also: AWS API Documentation
Request Syntax
client.create_app_instance(
Name='string',
Metadata='string',
ClientRequestToken='string'
)
string
[REQUIRED]
The name of the app instance.
string
The metadata of the app instance. Limited to a 1KB string in UTF-8.
string
[REQUIRED]
The ClientRequestToken of the app instance.
This field is autopopulated if not provided.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The Amazon Resource Number (ARN) of the app instance.
Creates a new ChannelModerator . A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
See also: AWS API Documentation
Request Syntax
client.create_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ARN of the moderator.
dict
Response Syntax
{
'ChannelArn': 'string',
'ChannelModerator': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
ChannelModerator (dict) --
The ARNs of the channel and the moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
A list of the channels moderated by an app instance user.
See also: AWS API Documentation
Request Syntax
client.list_channels_moderated_by_app_instance_user(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string'
)
string
The ARN of the user in the moderated channel.
integer
The maximum number of channels in the request.
string
The token returned from previous API requests until the number of channels moderated by the user is reached.
dict
Response Syntax
{
'Channels': [
{
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Channels (list) --
The moderated channels in the request.
(dict) --
Returns the summary data for a moderated channel.
ChannelSummary (dict) --
The summary data for a channel.
Name (string) --
The parameter of the action.
ChannelArn (string) --
The ARN of the channel summary.
Mode (string) --
The summary mode of the channel.
Privacy (string) --
The privacy setting of the channel being summarized, PUBLIC or HIDDEN .
Metadata (string) --
The metadata of the channel summary.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
NextToken (string) --
The token returned from previous API requests until the number of channels moderated by the user is reached.
Gets the retention settings for an app instance.
See also: AWS API Documentation
Request Syntax
client.get_app_instance_retention_settings(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the app instance.
dict
Response Syntax
{
'AppInstanceRetentionSettings': {
'ChannelRetentionSettings': {
'RetentionDays': 123
}
},
'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
AppInstanceRetentionSettings (dict) --
The retention settings for the app instance.
ChannelRetentionSettings (dict) --
The length of time in days to retain a channel.
RetentionDays (integer) --
The time in days to retain a channel.
InitiateDeletionTimestamp (datetime) --
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
Creates a channel to which you can add users and send messages.
Restriction : You can't change a channel's privacy.
See also: AWS API Documentation
Request Syntax
client.create_channel(
AppInstanceArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Privacy='PUBLIC'|'PRIVATE',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ARN of the channel request.
string
[REQUIRED]
The name of the channel.
string
The channel mode: UNRESTRICTED or RESTRICTED . Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
string
The channel's privacy level: PUBLIC or PRIVATE . Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the app instance.
string
The metadata of the creation request. Limited to 1KB and UTF-8.
string
[REQUIRED]
The client token for the request. An Idempotency token.
This field is autopopulated if not provided.
list
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Demotes an AppInstanceAdmin to an AppInstanceUser . This action does not delete the user.
See also: AWS API Documentation
Request Syntax
client.delete_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the app instance's administrator.
string
[REQUIRED]
The ARN of the app instance.
None
Returns the full details of an AppInstanceAdmin .
See also: AWS API Documentation
Request Syntax
client.describe_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the app instance administrator.
string
[REQUIRED]
The ARN of the app instance.
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 app instance user, the ARN of the app instance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
Admin (dict) --
The name and metadata of the app instance administrator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
AppInstanceArn (string) --
The ARN of the app instance administrator.
CreatedTimestamp (datetime) --
The time at which an administrator was created.
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
See also: AWS API Documentation
Request Syntax
client.delete_channel(
ChannelArn='string'
)
string
[REQUIRED]
The ARN of the channel being deleted.
None
The endpoint for the messaging session.
See also: AWS API Documentation
Request Syntax
client.get_messaging_session_endpoint()
dict
Response Syntax
{
'Endpoint': {
'Url': 'string'
}
}
Response Structure
(dict) --
Endpoint (dict) --
The endpoint returned in the response.
Url (string) --
The URL of a meeting session endpoint.
Lists all the moderators for a channel.
See also: AWS API Documentation
Request Syntax
client.list_channel_moderators(
ChannelArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the channel.
integer
The maximum number of moderators that you want returned.
string
The token passed by previous API calls until all requested moderators are returned.
dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelModerators': [
{
'Moderator': {
'Arn': 'string',
'Name': 'string'
}
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
NextToken (string) --
The token passed by previous API calls until all requested moderators are returned.
ChannelModerators (list) --
The information about and names of each moderator.
(dict) --
Summary data of the moderators in a channel.
Moderator (dict) --
The data for a moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Deletes a channel moderator.
See also: AWS API Documentation
Request Syntax
client.delete_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ARN of the moderator being deleted.
None
Removes a member from a channel.
See also: AWS API Documentation
Request Syntax
client.delete_channel_membership(
ChannelArn='string',
MemberArn='string'
)
string
[REQUIRED]
The ARN of the channel from which you want to remove the user.
string
[REQUIRED]
The ARN of the member that you're removing from the channel.
None
Updates the details for an AppInstanceUser . You can update names and metadata.
See also: AWS API Documentation
Request Syntax
client.update_app_instance_user(
AppInstanceUserArn='string',
Name='string',
Metadata='string'
)
string
[REQUIRED]
The ARN of the app instance user.
string
[REQUIRED]
The name of the app instance user.
string
The metadata of the app instance user.
dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The ARN of the app instance user.
Returns the full details of a channel ban.
See also: AWS API Documentation
Request Syntax
client.describe_channel_ban(
ChannelArn='string',
MemberArn='string'
)
string
[REQUIRED]
The ARN of the channel from which the user is banned.
string
[REQUIRED]
The ARN of the member being banned.
dict
Response Syntax
{
'ChannelBan': {
'Member': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
}
}
}
Response Structure
(dict) --
ChannelBan (dict) --
The the details of the ban.
Member (dict) --
The member being banned from the channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the channel from which a member is being banned.
CreatedTimestamp (datetime) --
The time at which the ban was created.
CreatedBy (dict) --
The parameter of the action.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
List all AppInstanceUsers created under a single app instance.
See also: AWS API Documentation
Request Syntax
client.list_app_instance_users(
AppInstanceArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the app instance.
integer
The maximum number of requests that you want returned.
string
The token passed by previous API calls until all requested users are returned.
dict
Response Syntax
{
'AppInstanceArn': 'string',
'AppInstanceUsers': [
{
'AppInstanceUserArn': 'string',
'Name': 'string',
'Metadata': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the app instance.
AppInstanceUsers (list) --
The information for each of the requested app instance users.
(dict) --
The app instance user summary data .
AppInstanceUserArn (string) --
The ARN of the app instance user.
Name (string) --
The name in an app instance user summary.
Metadata (string) --
The metadata in an app instance user summary.
NextToken (string) --
The token passed by previous API calls until all requested users are returned.
Deletes an AppInstanceUser .
See also: AWS API Documentation
Request Syntax
client.delete_app_instance_user(
AppInstanceUserArn='string'
)
string
[REQUIRED]
The ARN of the user request being deleted.
None
Lists all channel memberships in a channel.
See also: AWS API Documentation
Request Syntax
client.list_channel_memberships(
ChannelArn='string',
Type='DEFAULT'|'HIDDEN',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The maximum number of channel memberships that you want returned.
string
The membership type of a user, DEFAULT or HIDDEN . Default members are always returned as part of ListChannelMemberships . Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden members are not returned.
integer
The maximum number of channel memberships that you want returned.
string
The token passed by previous API calls until all requested channel memberships are returned..
dict
Response Syntax
{
'ChannelArn': 'string',
'ChannelMemberships': [
{
'Member': {
'Arn': 'string',
'Name': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
ChannelMemberships (list) --
The information for the requested channel memberships.
(dict) --
The summary data of a channel membership.
Member (dict) --
A member's summary data.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
NextToken (string) --
The token passed by previous API calls until all requested channel memberships are returned.
Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
See also: AWS API Documentation
Request Syntax
client.create_channel_membership(
ChannelArn='string',
MemberArn='string',
Type='DEFAULT'|'HIDDEN'
)
string
[REQUIRED]
The ARN of the channel to which you're adding users.
string
[REQUIRED]
The ARN of the member you want to add to the channel.
string
[REQUIRED]
The membership type of a user, DEFAULT or HIDDEN . Default members are always returned as part of ListChannelMemberships . Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden members are not returned. This is only supported by moderators.
dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Member (dict) --
The ARN and metadata of the member being added.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.