Table of Contents
ChimeSDKMessaging.Client¶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:
associate_channel_flow()batch_create_channel_membership()can_paginate()channel_flow_callback()close()create_channel()create_channel_ban()create_channel_flow()create_channel_membership()create_channel_moderator()delete_channel()delete_channel_ban()delete_channel_flow()delete_channel_membership()delete_channel_message()delete_channel_moderator()describe_channel()describe_channel_ban()describe_channel_flow()describe_channel_membership()describe_channel_membership_for_app_instance_user()describe_channel_moderated_by_app_instance_user()describe_channel_moderator()disassociate_channel_flow()get_channel_membership_preferences()get_channel_message()get_channel_message_status()get_messaging_session_endpoint()get_paginator()get_waiter()list_channel_bans()list_channel_flows()list_channel_memberships()list_channel_memberships_for_app_instance_user()list_channel_messages()list_channel_moderators()list_channels()list_channels_associated_with_channel_flow()list_channels_moderated_by_app_instance_user()list_sub_channels()list_tags_for_resource()put_channel_membership_preferences()redact_channel_message()search_channels()send_channel_message()tag_resource()untag_resource()update_channel()update_channel_flow()update_channel_message()update_channel_read_marker()associate_channel_flow(**kwargs)¶Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.
Note
Only administrators or channel moderators can associate a channel flow. 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.associate_channel_flow(
ChannelArn='string',
ChannelFlowArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the channel flow.
[REQUIRED]
The AppInstanceUserArn of the user making the API call.
None
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.NotFoundExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionbatch_create_channel_membership(**kwargs)¶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',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel to which you're adding users.
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 s of the members you want to add to the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
The ID of the SubChannel in the request.
Note
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
dict
Response Syntax
{
'BatchChannelMemberships': {
'InvitedBy': {
'Arn': 'string',
'Name': 'string'
},
'Type': 'DEFAULT'|'HIDDEN',
'Members': [
{
'Arn': 'string',
'Name': 'string'
},
],
'ChannelArn': 'string',
'SubChannelId': '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.
SubChannelId (string) --
The ID of the SubChannel.
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 AppInstanceUserArn of the member that the service couldn't add.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Exceptions
ChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.NotFoundExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ResourceLimitExceededExceptioncan_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.channel_flow_callback(**kwargs)¶Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
You can return one of the following processing responses:
See also: AWS API Documentation
Request Syntax
response = client.channel_flow_callback(
CallbackId='string',
ChannelArn='string',
DeleteResource=True|False,
ChannelMessage={
'MessageId': 'string',
'Content': 'string',
'Metadata': 'string',
'PushNotification': {
'Title': 'string',
'Body': 'string',
'Type': 'DEFAULT'|'VOIP'
},
'MessageAttributes': {
'string': {
'StringValues': [
'string',
]
}
},
'SubChannelId': 'string'
}
)
[REQUIRED]
The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.
This field is autopopulated if not provided.
[REQUIRED]
The ARN of the channel.
DENIED , pass this parameter with a value of true.[REQUIRED]
Stores information about the processed message.
The message ID.
The message content.
The message metadata.
The push notification configuration of the message.
The title of the push notification.
The body of the push notification.
Enum value that indicates the type of the push notification for a message. DEFAULT : Normal mobile push notification. VOIP : VOIP mobile push notification.
The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences .
A list of message attribute values.
The strings in a message attribute value.
The ID of the SubChannel.
dict
Response Syntax
{
'ChannelArn': 'string',
'CallbackId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
CallbackId (string) --
The call back ID passed in the request.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionclose()¶Closes underlying endpoint connections.
create_channel(**kwargs)¶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',
ChannelId='string',
MemberArns=[
'string',
],
ModeratorArns=[
'string',
],
ElasticChannelConfiguration={
'MaximumSubChannels': 123,
'TargetMembershipsPerSubChannel': 123,
'MinimumMembershipPercentage': 123
}
)
[REQUIRED]
The ARN of the channel request.
[REQUIRED]
The name of the channel.
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.PUBLIC or PRIVATE . Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance .[REQUIRED]
The client token for the request. An Idempotency token.
This field is autopopulated if not provided.
The tags for the creation request.
A tag object containing a key-value pair.
The key in a tag.
The value in a tag.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
The ARNs of the channel members in the request.
The ARNs of the channel moderators in the request.
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
The maximum number of SubChannels that you want to allow in the elastic channel.
The maximum number of members allowed in a SubChannel.
The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ResourceLimitExceededExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptioncreate_channel_ban(**kwargs)¶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 AppInstanceUserArn 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ResourceLimitExceededExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptioncreate_channel_flow(**kwargs)¶Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.
Channel flows process the following items:
Note
Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to Message types in the Amazon Chime developer guide .
See also: AWS API Documentation
Request Syntax
response = client.create_channel_flow(
AppInstanceArn='string',
Processors=[
{
'Name': 'string',
'Configuration': {
'Lambda': {
'ResourceArn': 'string',
'InvocationType': 'ASYNC'
}
},
'ExecutionOrder': 123,
'FallbackAction': 'CONTINUE'|'ABORT'
},
],
Name='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string'
)
[REQUIRED]
The ARN of the channel flow request.
[REQUIRED]
Information about the processor Lambda functions.
The information about a processor in a channel flow.
The name of the channel flow.
The information about the type of processor and its identifier.
Indicates that the processor is of type Lambda.
The ARN of the Lambda message processing function.
Controls how the Lambda function is invoked.
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.
[REQUIRED]
The name of the channel flow.
The tags for the creation request.
A tag object containing a key-value pair.
The key in a tag.
The value in a tag.
[REQUIRED]
The client token for the request. An Idempotency token.
dict
Response Syntax
{
'ChannelFlowArn': 'string'
}
Response Structure
(dict) --
ChannelFlowArn (string) --
The ARN of the channel flow.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ResourceLimitExceededExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptioncreate_channel_membership(**kwargs)¶Adds a user to a channel. The InvitedBy field in ChannelMembership 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',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel to which you're adding users.
[REQUIRED]
The AppInstanceUserArn 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.
The ID of the SubChannel in the request.
Note
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
},
'SubChannelId': '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.
SubChannelId (string) --
The ID of the SubChannel in the response.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.NotFoundExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ResourceLimitExceededExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptioncreate_channel_moderator(**kwargs)¶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 AppInstanceUserArn 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ResourceLimitExceededExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondelete_channel(**kwargs)¶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',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel being deleted.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
None
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondelete_channel_ban(**kwargs)¶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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondelete_channel_flow(**kwargs)¶Deletes a channel flow, an irreversible process. This is a developer API.
Note
This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_flow(
ChannelFlowArn='string'
)
[REQUIRED]
The ARN of the channel flow.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondelete_channel_membership(**kwargs)¶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',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel from which you want to remove the user.
[REQUIRED]
The AppInstanceUserArn of the member that you're removing from the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
The ID of the SubChannel in the request.
Note
Only for use by moderators.
None
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondelete_channel_message(**kwargs)¶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',
SubChannelId='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.
The ID of the SubChannel in the request.
Note
Only required when deleting messages in a SubChannel that the user belongs to.
None
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondelete_channel_moderator(**kwargs)¶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 AppInstanceUserArn of the moderator being deleted.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
None
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondescribe_channel(**kwargs)¶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),
'ChannelFlowArn': 'string',
'ElasticChannelConfiguration': {
'MaximumSubChannels': 123,
'TargetMembershipsPerSubChannel': 123,
'MinimumMembershipPercentage': 123
}
}
}
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.
ChannelFlowArn (string) --
The ARN of the channel flow.
ElasticChannelConfiguration (dict) --
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
MaximumSubChannels (integer) --
The maximum number of SubChannels that you want to allow in the elastic channel.
TargetMembershipsPerSubChannel (integer) --
The maximum number of members allowed in a SubChannel.
MinimumMembershipPercentage (integer) --
The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondescribe_channel_ban(**kwargs)¶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 AppInstanceUserArn 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.NotFoundExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondescribe_channel_flow(**kwargs)¶Returns the full details of a channel flow in an Amazon Chime AppInstance . This is a developer API.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_flow(
ChannelFlowArn='string'
)
[REQUIRED]
The ARN of the channel flow.
{
'ChannelFlow': {
'ChannelFlowArn': 'string',
'Processors': [
{
'Name': 'string',
'Configuration': {
'Lambda': {
'ResourceArn': 'string',
'InvocationType': 'ASYNC'
}
},
'ExecutionOrder': 123,
'FallbackAction': 'CONTINUE'|'ABORT'
},
],
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The channel flow details.
The ARN of the channel flow.
Information about the processor Lambda functions.
The information about a processor in a channel flow.
The name of the channel flow.
The information about the type of processor and its identifier.
Indicates that the processor is of type Lambda.
The ARN of the Lambda message processing function.
Controls how the Lambda function is invoked.
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.
The name of the channel flow.
The time at which the channel flow was created.
The time at which a channel flow was updated.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondescribe_channel_membership(**kwargs)¶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',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the member.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.
Note
Only required to get a user’s SubChannel membership details.
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),
'SubChannelId': 'string'
}
}
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.
SubChannelId (string) --
The ID of the SubChannel that a user belongs to.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.NotFoundExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondescribe_channel_membership_for_app_instance_user(**kwargs)¶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),
'SubChannelId': 'string'
}
}
}
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 persistent 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 an AppInstanceUser last marked a channel as read.
SubChannelId (string) --
The ID of the SubChannel that the AppInstanceUser is a member of.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondescribe_channel_moderated_by_app_instance_user(**kwargs)¶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 persistent message in a channel was sent.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondescribe_channel_moderator(**kwargs)¶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 AppInstanceUserArn 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.NotFoundExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiondisassociate_channel_flow(**kwargs)¶Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.
Note
Only administrators or channel moderators can disassociate a channel flow. 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.disassociate_channel_flow(
ChannelArn='string',
ChannelFlowArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the channel flow.
[REQUIRED]
The AppInstanceUserArn of the user making the API call.
None
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.NotFoundExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionget_channel_membership_preferences(**kwargs)¶Gets the membership preferences of an AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users. Banned users can't retrieve membership preferences for the channel from which they are banned.
See also: AWS API Documentation
Request Syntax
response = client.get_channel_membership_preferences(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the member retrieving the preferences.
[REQUIRED]
The AppInstanceUserARN of the user making the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
},
'Preferences': {
'PushNotifications': {
'AllowNotifications': 'ALL'|'NONE'|'FILTERED',
'FilterRule': 'string'
}
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Member (dict) --
The details of a user.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Preferences (dict) --
The channel membership preferences for an AppInstanceUser .
PushNotifications (dict) --
The push notification configuration of a message.
AllowNotifications (string) --
Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.
FilterRule (string) --
The simple JSON object used to send a subset of a push notification to the requested member.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionget_channel_message(**kwargs)¶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',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ID of the message.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
The ID of the SubChannel in the request.
Note
Only required when getting messages in a SubChannel that the user belongs to.
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',
'Status': {
'Value': 'SENT'|'PENDING'|'FAILED'|'DENIED',
'Detail': 'string'
},
'MessageAttributes': {
'string': {
'StringValues': [
'string',
]
}
},
'SubChannelId': 'string'
}
}
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.
Status (dict) --
The status of the channel message.
Value (string) --
The message status value.
Detail (string) --
Contains more details about the messasge status.
MessageAttributes (dict) --
The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences .
(string) --
(dict) --
A list of message attribute values.
StringValues (list) --
The strings in a message attribute value.
SubChannelId (string) --
The ID of the SubChannel.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.NotFoundExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionget_channel_message_status(**kwargs)¶Gets message status for a specified messageId . Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.
Messages can have any one of these statuses.
SENT
Message processed successfully
PENDING
Ongoing processing
FAILED
Processing failed
DENIED
Messasge denied by the processor
Note
x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the headerSee also: AWS API Documentation
Request Syntax
response = client.get_channel_message_status(
ChannelArn='string',
MessageId='string',
ChimeBearer='string',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel
[REQUIRED]
The ID of the message.
[REQUIRED]
The AppInstanceUserArn of the user making the API call.
The ID of the SubChannel in the request.
Note
Only required when getting message status in a SubChannel that the user belongs to.
dict
Response Syntax
{
'Status': {
'Value': 'SENT'|'PENDING'|'FAILED'|'DENIED',
'Detail': 'string'
}
}
Response Structure
(dict) --
Status (dict) --
The message status and details.
Value (string) --
The message status value.
Detail (string) --
Contains more details about the messasge status.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionget_messaging_session_endpoint()¶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
ChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.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_channel_bans(**kwargs)¶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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_channel_flows(**kwargs)¶Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_flows(
AppInstanceArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the app instance.
dict
Response Syntax
{
'ChannelFlows': [
{
'ChannelFlowArn': 'string',
'Name': 'string',
'Processors': [
{
'Name': 'string',
'Configuration': {
'Lambda': {
'ResourceArn': 'string',
'InvocationType': 'ASYNC'
}
},
'ExecutionOrder': 123,
'FallbackAction': 'CONTINUE'|'ABORT'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelFlows (list) --
The information about each channel flow.
(dict) --
Summary of details of a channel flow.
ChannelFlowArn (string) --
The ARN of the channel flow.
Name (string) --
The name of the channel flow.
Processors (list) --
Information about the processor Lambda functions.
(dict) --
The information about a processor in a channel flow.
Name (string) --
The name of the channel flow.
Configuration (dict) --
The information about the type of processor and its identifier.
Lambda (dict) --
Indicates that the processor is of type Lambda.
ResourceArn (string) --
The ARN of the Lambda message processing function.
InvocationType (string) --
Controls how the Lambda function is invoked.
ExecutionOrder (integer) --
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
FallbackAction (string) --
Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.
NextToken (string) --
The token passed by previous API calls until all requested channels are returned.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_channel_memberships(**kwargs)¶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.
If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_memberships(
ChannelArn='string',
Type='DEFAULT'|'HIDDEN',
MaxResults=123,
NextToken='string',
ChimeBearer='string',
SubChannelId='string'
)
[REQUIRED]
The maximum number of channel memberships that you want returned.
DEFAULT or HIDDEN . Default members are returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN .[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
The ID of the SubChannel in the request.
Note
Only required when listing a user's memberships in a particular sub-channel of an elastic channel.
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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_channel_memberships_for_app_instance_user(**kwargs)¶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'
)
AppInstanceUser s[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),
'SubChannelId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelMemberships (list) --
The information for the requested channel memberships.
(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 persistent 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 an AppInstanceUser last marked a channel as read.
SubChannelId (string) --
The ID of the SubChannel that the AppInstanceUser is a member of.
NextToken (string) --
The token passed by previous API calls until all requested users are returned.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_channel_messages(**kwargs)¶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',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
The ID of the SubChannel in the request.
Note
Only required when listing the messages in a SubChannel that the user belongs to.
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,
'Status': {
'Value': 'SENT'|'PENDING'|'FAILED'|'DENIED',
'Detail': 'string'
},
'MessageAttributes': {
'string': {
'StringValues': [
'string',
]
}
}
},
],
'SubChannelId': 'string'
}
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.
Status (dict) --
The message status. The status value is SENT for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.
Value (string) --
The message status value.
Detail (string) --
Contains more details about the messasge status.
MessageAttributes (dict) --
The message attribues listed in a the summary of a channel message.
(string) --
(dict) --
A list of message attribute values.
StringValues (list) --
The strings in a message attribute value.
SubChannelId (string) --
The ID of the SubChannel in the response.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_channel_moderators(**kwargs)¶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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_channels(**kwargs)¶Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
PUBLIC to retrieve all public channels in the account.AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.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 .
PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.[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 persistent message in a channel was sent.
NextToken (string) --
The token returned from previous API requests until the number of channels is reached.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_channels_associated_with_channel_flow(**kwargs)¶Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
See also: AWS API Documentation
Request Syntax
response = client.list_channels_associated_with_channel_flow(
ChannelFlowArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the channel flow.
dict
Response Syntax
{
'Channels': [
{
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Channels (list) --
The information about each channel.
(dict) --
Summary of details of a channel associated with channel flow.
Name (string) --
The name of the channel flow.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The channel's privacy setting.
Metadata (string) --
The channel's metadata.
NextToken (string) --
The token passed by previous API calls until all requested channels are returned.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_channels_moderated_by_app_instance_user(**kwargs)¶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 persistent 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionlist_sub_channels(**kwargs)¶Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.
See also: AWS API Documentation
Request Syntax
response = client.list_sub_channels(
ChannelArn='string',
ChimeBearer='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of elastic channel.
[REQUIRED]
The AppInstanceUserArn of the user making the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'SubChannels': [
{
'SubChannelId': 'string',
'MembershipCount': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of elastic channel.
SubChannels (list) --
The information about each sub-channel.
(dict) --
Summary of the sub-channels associated with the elastic channel.
SubChannelId (string) --
The unique ID of a SubChannel.
MembershipCount (integer) --
The number of members in a SubChannel.
NextToken (string) --
The token passed by previous API calls until all requested sub-channels are returned.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionLists the tags applied to an Amazon Chime SDK messaging 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionput_channel_membership_preferences(**kwargs)¶Sets the membership preferences of an AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users can't set membership preferences for the channel from which they are banned.
See also: AWS API Documentation
Request Syntax
response = client.put_channel_membership_preferences(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string',
Preferences={
'PushNotifications': {
'AllowNotifications': 'ALL'|'NONE'|'FILTERED',
'FilterRule': 'string'
}
}
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the member setting the preferences.
[REQUIRED]
The AppInstanceUserARN of the user making the API call.
[REQUIRED]
The channel membership preferences of an AppInstanceUser .
The push notification configuration of a message.
Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.
The simple JSON object used to send a subset of a push notification to the requested member.
dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
},
'Preferences': {
'PushNotifications': {
'AllowNotifications': 'ALL'|'NONE'|'FILTERED',
'FilterRule': 'string'
}
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Member (dict) --
The details of a user.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Preferences (dict) --
The ARN and metadata of the member being added.
PushNotifications (dict) --
The push notification configuration of a message.
AllowNotifications (string) --
Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.
FilterRule (string) --
The simple JSON object used to send a subset of a push notification to the requested member.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionredact_channel_message(**kwargs)¶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',
SubChannelId='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',
'SubChannelId': '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.
SubChannelId (string) --
The ID of the SubChannel in the response.
Note
Only required when redacting messages in a SubChannel that the user belongs to.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionsearch_channels(**kwargs)¶Allows ChimeBearer to search channels by channel members. AppInstanceUsers can search across the channels that they belong to. AppInstanceAdmins can search across all channels.
See also: AWS API Documentation
Request Syntax
response = client.search_channels(
ChimeBearer='string',
Fields=[
{
'Key': 'MEMBERS',
'Values': [
'string',
],
'Operator': 'EQUALS'|'INCLUDES'
},
],
MaxResults=123,
NextToken='string'
)
AppInstanceUserArn of the user making the API call.[REQUIRED]
A list of the Field objects in the channel being searched.
A Field of the channel that you want to search.
An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.
Note
This operation isn't supported for AppInstanceUsers with large number of memberships.
The operator used to compare field values, currently EQUALS or INCLUDES . Use the EQUALS operator to find channels whose memberships equal the specified values. Use the INCLUDES operator to find channels whose memberships include the specified values.
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) --
A list of the channels in the request.
(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 persistent message in a channel was sent.
NextToken (string) --
The token returned from previous API responses until the number of channels is reached.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionsend_channel_message(**kwargs)¶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',
PushNotification={
'Title': 'string',
'Body': 'string',
'Type': 'DEFAULT'|'VOIP'
},
MessageAttributes={
'string': {
'StringValues': [
'string',
]
}
},
SubChannelId='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.
The push notification configuration of the message.
The title of the push notification.
The body of the push notification.
Enum value that indicates the type of the push notification for a message. DEFAULT : Normal mobile push notification. VOIP : VOIP mobile push notification.
The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences .
A list of message attribute values.
The strings in a message attribute value.
dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string',
'Status': {
'Value': 'SENT'|'PENDING'|'FAILED'|'DENIED',
'Detail': 'string'
},
'SubChannelId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID string assigned to each message.
Status (dict) --
The status of the channel message.
Value (string) --
The message status value.
Detail (string) --
Contains more details about the messasge status.
SubChannelId (string) --
The ID of the SubChannel in the response.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptiontag_resource(**kwargs)¶Applies the specified tags to the specified Amazon Chime SDK messaging 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ResourceLimitExceededExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionuntag_resource(**kwargs)¶Removes the specified tags from the specified Amazon Chime SDK messaging 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionupdate_channel(**kwargs)¶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 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
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionupdate_channel_flow(**kwargs)¶Updates channel flow attributes. This is a developer API.
See also: AWS API Documentation
Request Syntax
response = client.update_channel_flow(
ChannelFlowArn='string',
Processors=[
{
'Name': 'string',
'Configuration': {
'Lambda': {
'ResourceArn': 'string',
'InvocationType': 'ASYNC'
}
},
'ExecutionOrder': 123,
'FallbackAction': 'CONTINUE'|'ABORT'
},
],
Name='string'
)
[REQUIRED]
The ARN of the channel flow.
[REQUIRED]
Information about the processor Lambda functions
The information about a processor in a channel flow.
The name of the channel flow.
The information about the type of processor and its identifier.
Indicates that the processor is of type Lambda.
The ARN of the Lambda message processing function.
Controls how the Lambda function is invoked.
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.
[REQUIRED]
The name of the channel flow.
dict
Response Syntax
{
'ChannelFlowArn': 'string'
}
Response Structure
(dict) --
ChannelFlowArn (string) --
The ARN of the channel flow.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionupdate_channel_message(**kwargs)¶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',
SubChannelId='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.
The ID of the SubChannel in the request.
Note
Only required when updating messages in a SubChannel that the user belongs to.
dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string',
'Status': {
'Value': 'SENT'|'PENDING'|'FAILED'|'DENIED',
'Detail': 'string'
},
'SubChannelId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID string of the message being updated.
Status (dict) --
The status of the message update.
Value (string) --
The message status value.
Detail (string) --
Contains more details about the messasge status.
SubChannelId (string) --
The ID of the SubChannel in the response.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionupdate_channel_read_marker(**kwargs)¶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',
SubChannelId='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'SubChannelId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
SubChannelId (string) --
The ID of the SubChannel in the response.
Exceptions
ChimeSDKMessaging.Client.exceptions.BadRequestExceptionChimeSDKMessaging.Client.exceptions.ForbiddenExceptionChimeSDKMessaging.Client.exceptions.ConflictExceptionChimeSDKMessaging.Client.exceptions.UnauthorizedClientExceptionChimeSDKMessaging.Client.exceptions.ThrottledClientExceptionChimeSDKMessaging.Client.exceptions.ServiceUnavailableExceptionChimeSDKMessaging.Client.exceptions.ServiceFailureExceptionThe available paginators are: