Table of Contents
A low-level client representing Amazon Chime SDK Messaging
The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging
import boto3
client = boto3.client('chime-sdk-messaging')
These are the available methods:
Adds a specified number of users to a channel.
See also: AWS API Documentation
Request Syntax
response = client.batch_create_channel_membership(
ChannelArn='string',
Type='DEFAULT'|'HIDDEN',
MemberArns=[
'string',
],
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel to which you're adding users.
[REQUIRED]
The ARNs of the members you want to add to the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'BatchChannelMemberships': {
'InvitedBy': {
'Arn': 'string',
'Name': 'string'
},
'Type': 'DEFAULT'|'HIDDEN',
'Members': [
{
'Arn': 'string',
'Name': 'string'
},
],
'ChannelArn': 'string'
},
'Errors': [
{
'MemberArn': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
BatchChannelMemberships (dict) --
The list of channel memberships in the response.
InvitedBy (dict) --
The identifier of the member who invited another member.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Type (string) --
The membership types set for the channel users.
Members (list) --
The users successfully added to the request.
(dict) --
The details of a user.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the channel to which you're adding users.
Errors (list) --
If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
(dict) --
A list of failed member ARNs, error codes, and error messages.
MemberArn (string) --
The ARN of the member that the service couldn't add.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Exceptions
Check if an operation can be paginated.
Creates a channel to which you can add users and send messages.
Restriction : You can't change a channel's privacy.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.create_channel(
AppInstanceArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Privacy='PUBLIC'|'PRIVATE',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel request.
[REQUIRED]
The name of the channel.
[REQUIRED]
The client token for the request. An Idempotency token.
This field is autopopulated if not provided.
The tags for the creation request.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Exceptions
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.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.create_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the ban request.
[REQUIRED]
The ARN of the member being banned.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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.
Exceptions
Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:
Privacy settings impact this action as follows:
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.create_channel_membership(
ChannelArn='string',
MemberArn='string',
Type='DEFAULT'|'HIDDEN',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel to which you're adding users.
[REQUIRED]
The ARN of the member you want to add to the channel.
[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.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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.
Exceptions
Creates a new ChannelModerator . A channel moderator can:
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.create_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the moderator.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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.
Exceptions
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel(
ChannelArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel being deleted.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
None
Exceptions
Removes a user from a channel's ban list.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel from which the AppInstanceUser was banned.
[REQUIRED]
The ARN of the AppInstanceUser that you want to reinstate.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
None
Exceptions
Removes a member from a channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_membership(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel from which you want to remove the user.
[REQUIRED]
The ARN of the member that you're removing from the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
None
Exceptions
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ID of the message being deleted.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
None
Exceptions
Deletes a channel moderator.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the moderator being deleted.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
None
Exceptions
Returns the full details of a channel in an Amazon Chime AppInstance .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel(
ChannelArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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 a channel.
ChannelArn (string) --
The ARN of a channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The channel's privacy setting.
Metadata (string) --
The channel's metadata.
CreatedBy (dict) --
The AppInstanceUser 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 AppInstanceUser created the channel.
LastMessageTimestamp (datetime) --
The time at which a member sent the last message in the channel.
LastUpdatedTimestamp (datetime) --
The time at which a channel was last updated.
Exceptions
Returns the full details of a channel ban.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel from which the user is banned.
[REQUIRED]
The ARN of the member being banned.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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 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 AppInstanceUser who created the ban.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Returns the full details of a user's channel membership.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_membership(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the member.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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.
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.
Exceptions
Returns the details of a channel based on the membership of the specified AppInstanceUser .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_membership_for_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel to which the user belongs.
[REQUIRED]
The ARN of the user in a channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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) --
Returns the channel data for an AppInstance .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
AppInstanceUserMembershipSummary (dict) --
Returns the channel membership data for an AppInstance .
Type (string) --
The type of ChannelMembership .
ReadMarkerTimestamp (datetime) --
The time at which a message was last read.
Exceptions
Returns the full details of a channel moderated by the specified AppInstanceUser .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_moderated_by_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the moderated channel.
[REQUIRED]
The ARN of the AppInstanceUser in the moderated channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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) --
Summary of the details of a Channel .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
Exceptions
Returns the full details of a single ChannelModerator.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the channel moderator.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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 AppInstanceUser who created the moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets the full details of a channel message.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.get_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ID of the message.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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.
Persistence (string) --
The persistence setting for a channel message.
Exceptions
The details of the endpoint for the messaging session.
See also: AWS API Documentation
Request Syntax
response = client.get_messaging_session_endpoint()
{
'Endpoint': {
'Url': 'string'
}
}
Response Structure
The endpoint returned in the response.
The endpoint to which you establish a websocket connection.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists all the users banned from a particular channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_bans(
ChannelArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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) --
Summary of the details of a ChannelBan .
Member (dict) --
The member being banned from a channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Lists all channel memberships in a channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_memberships(
ChannelArn='string',
Type='DEFAULT'|'HIDDEN',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The maximum number of channel memberships that you want returned.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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) --
Summary of the details of a ChannelMembership .
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.
Exceptions
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.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_memberships_for_app_instance_user(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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) --
Summary of the channel membership details of an AppInstanceUser .
ChannelSummary (dict) --
Returns the channel data for an AppInstance .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
AppInstanceUserMembershipSummary (dict) --
Returns the channel membership data for an AppInstance .
Type (string) --
The type of ChannelMembership .
ReadMarkerTimestamp (datetime) --
The time at which a message was last read.
NextToken (string) --
The token passed by previous API calls until all requested users are returned.
Exceptions
List all the messages in a channel. Returns a paginated list of ChannelMessages . By default, sorted by creation timestamp in descending order.
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.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_messages(
ChannelArn='string',
SortOrder='ASCENDING'|'DESCENDING',
NotBefore=datetime(2015, 1, 1),
NotAfter=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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) --
Summary of the messages in a Channel .
MessageId (string) --
The ID of the message.
Content (string) --
The content of the message.
Metadata (string) --
The metadata of the message.
Type (string) --
The type of message.
CreatedTimestamp (datetime) --
The time at which the message summary was created.
LastUpdatedTimestamp (datetime) --
The time at which a message was last updated.
LastEditedTimestamp (datetime) --
The time at which a message was last edited.
Sender (dict) --
The message sender.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Redacted (boolean) --
Indicates whether a message was redacted.
Exceptions
Lists all the moderators for a channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_moderators(
ChannelArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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 of the details of a ChannelModerator .
Moderator (dict) --
The data for a moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channels(
AppInstanceArn='string',
Privacy='PUBLIC'|'PRIVATE',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the AppInstance .
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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) --
Summary of the details of a Channel .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
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.
Exceptions
A list of the channels moderated by an AppInstanceUser .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channels_moderated_by_app_instance_user(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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) --
Summary of the details of a moderated channel.
ChannelSummary (dict) --
Summary of the details of a Channel .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
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.
Exceptions
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.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.redact_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel containing the messages that you want to redact.
[REQUIRED]
The ID of the message being redacted.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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.
Exceptions
Sends a message to a particular channel that the member is a part of.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Also, 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
response = client.send_channel_message(
ChannelArn='string',
Content='string',
Type='STANDARD'|'CONTROL',
Persistence='PERSISTENT'|'NON_PERSISTENT',
Metadata='string',
ClientRequestToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The content of the message.
[REQUIRED]
The type of message, STANDARD or CONTROL .
[REQUIRED]
Boolean that controls whether the message is persisted on the back end. Required.
[REQUIRED]
The Idempotency token for each client request.
This field is autopopulated if not provided.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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.
Exceptions
Update a channel's attributes.
Restriction : You can't change a channel's privacy.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.update_channel(
ChannelArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Metadata='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The name of the channel.
[REQUIRED]
The mode of the update request.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Exceptions
Updates the content of a message.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.update_channel_message(
ChannelArn='string',
MessageId='string',
Content='string',
Metadata='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ID string of the message being updated.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
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.
Exceptions
The details of the time when a user last read messages in a channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.update_channel_read_marker(
ChannelArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Exceptions
The available paginators are: