Skip to content

ChimeSDKMessagingClient#

Index > ChimeSDKMessaging > ChimeSDKMessagingClient

Auto-generated documentation for ChimeSDKMessaging type annotations stubs module mypy-boto3-chime-sdk-messaging.

ChimeSDKMessagingClient#

Type annotations and code completion for boto3.client("chime-sdk-messaging"). boto3 documentation

# ChimeSDKMessagingClient usage example

from boto3.session import Session
from mypy_boto3_chime_sdk_messaging.client import ChimeSDKMessagingClient

def get_chime-sdk-messaging_client() -> ChimeSDKMessagingClient:
    return Session().client("chime-sdk-messaging")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("chime-sdk-messaging").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("chime-sdk-messaging")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.NotFoundException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ServiceFailureException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottledClientException,
    client.exceptions.UnauthorizedClientException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_chime_sdk_messaging.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods#

associate_channel_flow#

Associates a channel flow with a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").associate_channel_flow method. boto3 documentation

# associate_channel_flow method definition

def associate_channel_flow(
    self,
    *,
    ChannelArn: str,
    ChannelFlowArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# associate_channel_flow method usage example with argument unpacking

kwargs: AssociateChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelFlowArn": ...,
    "ChimeBearer": ...,
}

parent.associate_channel_flow(**kwargs)
  1. See AssociateChannelFlowRequestRequestTypeDef

batch_create_channel_membership#

Adds a specified number of users and bots to a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").batch_create_channel_membership method. boto3 documentation

# batch_create_channel_membership method definition

def batch_create_channel_membership(
    self,
    *,
    ChannelArn: str,
    MemberArns: Sequence[str],
    ChimeBearer: str,
    Type: ChannelMembershipTypeType = ...,  # (1)
    SubChannelId: str = ...,
) -> BatchCreateChannelMembershipResponseTypeDef:  # (2)
    ...
  1. See ChannelMembershipTypeType
  2. See BatchCreateChannelMembershipResponseTypeDef 
# batch_create_channel_membership method usage example with argument unpacking

kwargs: BatchCreateChannelMembershipRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArns": ...,
    "ChimeBearer": ...,
}

parent.batch_create_channel_membership(**kwargs)
  1. See BatchCreateChannelMembershipRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("chime-sdk-messaging").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

channel_flow_callback#

Calls back Amazon Chime SDK messaging with a processing response message.

Type annotations and code completion for boto3.client("chime-sdk-messaging").channel_flow_callback method. boto3 documentation

# channel_flow_callback method definition

def channel_flow_callback(
    self,
    *,
    CallbackId: str,
    ChannelArn: str,
    ChannelMessage: ChannelMessageCallbackTypeDef,  # (1)
    DeleteResource: bool = ...,
) -> ChannelFlowCallbackResponseTypeDef:  # (2)
    ...
  1. See ChannelMessageCallbackTypeDef
  2. See ChannelFlowCallbackResponseTypeDef 
# channel_flow_callback method usage example with argument unpacking

kwargs: ChannelFlowCallbackRequestRequestTypeDef = {  # (1)
    "CallbackId": ...,
    "ChannelArn": ...,
    "ChannelMessage": ...,
}

parent.channel_flow_callback(**kwargs)
  1. See ChannelFlowCallbackRequestRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("chime-sdk-messaging").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_channel#

Creates a channel to which you can add users and send messages.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel method. boto3 documentation

# create_channel method definition

def create_channel(
    self,
    *,
    AppInstanceArn: str,
    Name: str,
    ClientRequestToken: str,
    ChimeBearer: str,
    Mode: ChannelModeType = ...,  # (1)
    Privacy: ChannelPrivacyType = ...,  # (2)
    Metadata: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ChannelId: str = ...,
    MemberArns: Sequence[str] = ...,
    ModeratorArns: Sequence[str] = ...,
    ElasticChannelConfiguration: ElasticChannelConfigurationTypeDef = ...,  # (4)
    ExpirationSettings: ExpirationSettingsTypeDef = ...,  # (5)
) -> CreateChannelResponseTypeDef:  # (6)
    ...
  1. See ChannelModeType
  2. See ChannelPrivacyType
  3. See TagTypeDef
  4. See ElasticChannelConfigurationTypeDef
  5. See ExpirationSettingsTypeDef
  6. See CreateChannelResponseTypeDef 
# create_channel method usage example with argument unpacking

kwargs: CreateChannelRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "Name": ...,
    "ClientRequestToken": ...,
    "ChimeBearer": ...,
}

parent.create_channel(**kwargs)
  1. See CreateChannelRequestRequestTypeDef

create_channel_ban#

Permanently bans a member from a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel_ban method. boto3 documentation

# create_channel_ban method definition

def create_channel_ban(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
) -> CreateChannelBanResponseTypeDef:  # (1)
    ...
  1. See CreateChannelBanResponseTypeDef 
# create_channel_ban method usage example with argument unpacking

kwargs: CreateChannelBanRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.create_channel_ban(**kwargs)
  1. See CreateChannelBanRequestRequestTypeDef

create_channel_flow#

Creates a channel flow, a container for processors.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel_flow method. boto3 documentation

# create_channel_flow method definition

def create_channel_flow(
    self,
    *,
    AppInstanceArn: str,
    Processors: Sequence[ProcessorTypeDef],  # (1)
    Name: str,
    ClientRequestToken: str,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateChannelFlowResponseTypeDef:  # (3)
    ...
  1. See ProcessorTypeDef
  2. See TagTypeDef
  3. See CreateChannelFlowResponseTypeDef 
# create_channel_flow method usage example with argument unpacking

kwargs: CreateChannelFlowRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "Processors": ...,
    "Name": ...,
    "ClientRequestToken": ...,
}

parent.create_channel_flow(**kwargs)
  1. See CreateChannelFlowRequestRequestTypeDef

create_channel_membership#

Adds a member to a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel_membership method. boto3 documentation

# create_channel_membership method definition

def create_channel_membership(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    Type: ChannelMembershipTypeType,  # (1)
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> CreateChannelMembershipResponseTypeDef:  # (2)
    ...
  1. See ChannelMembershipTypeType
  2. See CreateChannelMembershipResponseTypeDef 
# create_channel_membership method usage example with argument unpacking

kwargs: CreateChannelMembershipRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "Type": ...,
    "ChimeBearer": ...,
}

parent.create_channel_membership(**kwargs)
  1. See CreateChannelMembershipRequestRequestTypeDef

create_channel_moderator#

Creates a new ChannelModerator.

Type annotations and code completion for boto3.client("chime-sdk-messaging").create_channel_moderator method. boto3 documentation

# create_channel_moderator method definition

def create_channel_moderator(
    self,
    *,
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,
) -> CreateChannelModeratorResponseTypeDef:  # (1)
    ...
  1. See CreateChannelModeratorResponseTypeDef 
# create_channel_moderator method usage example with argument unpacking

kwargs: CreateChannelModeratorRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelModeratorArn": ...,
    "ChimeBearer": ...,
}

parent.create_channel_moderator(**kwargs)
  1. See CreateChannelModeratorRequestRequestTypeDef

delete_channel#

Immediately makes a channel and its memberships inaccessible and marks them for deletion.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel method. boto3 documentation

# delete_channel method definition

def delete_channel(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_channel method usage example with argument unpacking

kwargs: DeleteChannelRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.delete_channel(**kwargs)
  1. See DeleteChannelRequestRequestTypeDef

delete_channel_ban#

Removes a member from a channel's ban list.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_ban method. boto3 documentation

# delete_channel_ban method definition

def delete_channel_ban(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_channel_ban method usage example with argument unpacking

kwargs: DeleteChannelBanRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.delete_channel_ban(**kwargs)
  1. See DeleteChannelBanRequestRequestTypeDef

delete_channel_flow#

Deletes a channel flow, an irreversible process.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_flow method. boto3 documentation

# delete_channel_flow method definition

def delete_channel_flow(
    self,
    *,
    ChannelFlowArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_channel_flow method usage example with argument unpacking

kwargs: DeleteChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelFlowArn": ...,
}

parent.delete_channel_flow(**kwargs)
  1. See DeleteChannelFlowRequestRequestTypeDef

delete_channel_membership#

Removes a member from a channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_membership method. boto3 documentation

# delete_channel_membership method definition

def delete_channel_membership(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_channel_membership method usage example with argument unpacking

kwargs: DeleteChannelMembershipRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.delete_channel_membership(**kwargs)
  1. See DeleteChannelMembershipRequestRequestTypeDef

delete_channel_message#

Deletes a channel message.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_message method. boto3 documentation

# delete_channel_message method definition

def delete_channel_message(
    self,
    *,
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_channel_message method usage example with argument unpacking

kwargs: DeleteChannelMessageRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MessageId": ...,
    "ChimeBearer": ...,
}

parent.delete_channel_message(**kwargs)
  1. See DeleteChannelMessageRequestRequestTypeDef

delete_channel_moderator#

Deletes a channel moderator.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_channel_moderator method. boto3 documentation

# delete_channel_moderator method definition

def delete_channel_moderator(
    self,
    *,
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_channel_moderator method usage example with argument unpacking

kwargs: DeleteChannelModeratorRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelModeratorArn": ...,
    "ChimeBearer": ...,
}

parent.delete_channel_moderator(**kwargs)
  1. See DeleteChannelModeratorRequestRequestTypeDef

delete_messaging_streaming_configurations#

Deletes the streaming configurations for an AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-messaging").delete_messaging_streaming_configurations method. boto3 documentation

# delete_messaging_streaming_configurations method definition

def delete_messaging_streaming_configurations(
    self,
    *,
    AppInstanceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_messaging_streaming_configurations method usage example with argument unpacking

kwargs: DeleteMessagingStreamingConfigurationsRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
}

parent.delete_messaging_streaming_configurations(**kwargs)
  1. See DeleteMessagingStreamingConfigurationsRequestRequestTypeDef

describe_channel#

Returns the full details of a channel in an Amazon Chime AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel method. boto3 documentation

# describe_channel method definition

def describe_channel(
    self,
    *,
    ChannelArn: str,
    ChimeBearer: str,
) -> DescribeChannelResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelResponseTypeDef 
# describe_channel method usage example with argument unpacking

kwargs: DescribeChannelRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel(**kwargs)
  1. See DescribeChannelRequestRequestTypeDef

describe_channel_ban#

Returns the full details of a channel ban.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_ban method. boto3 documentation

# describe_channel_ban method definition

def describe_channel_ban(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
) -> DescribeChannelBanResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelBanResponseTypeDef 
# describe_channel_ban method usage example with argument unpacking

kwargs: DescribeChannelBanRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_ban(**kwargs)
  1. See DescribeChannelBanRequestRequestTypeDef

describe_channel_flow#

Returns the full details of a channel flow in an Amazon Chime AppInstance.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_flow method. boto3 documentation

# describe_channel_flow method definition

def describe_channel_flow(
    self,
    *,
    ChannelFlowArn: str,
) -> DescribeChannelFlowResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelFlowResponseTypeDef 
# describe_channel_flow method usage example with argument unpacking

kwargs: DescribeChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelFlowArn": ...,
}

parent.describe_channel_flow(**kwargs)
  1. See DescribeChannelFlowRequestRequestTypeDef

describe_channel_membership#

Returns the full details of a user's channel membership.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_membership method. boto3 documentation

# describe_channel_membership method definition

def describe_channel_membership(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> DescribeChannelMembershipResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelMembershipResponseTypeDef 
# describe_channel_membership method usage example with argument unpacking

kwargs: DescribeChannelMembershipRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_membership(**kwargs)
  1. See DescribeChannelMembershipRequestRequestTypeDef

describe_channel_membership_for_app_instance_user#

Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_membership_for_app_instance_user method. boto3 documentation

# describe_channel_membership_for_app_instance_user method definition

def describe_channel_membership_for_app_instance_user(
    self,
    *,
    ChannelArn: str,
    AppInstanceUserArn: str,
    ChimeBearer: str,
) -> DescribeChannelMembershipForAppInstanceUserResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelMembershipForAppInstanceUserResponseTypeDef 
# describe_channel_membership_for_app_instance_user method usage example with argument unpacking

kwargs: DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "AppInstanceUserArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_membership_for_app_instance_user(**kwargs)
  1. See DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef

describe_channel_moderated_by_app_instance_user#

Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_moderated_by_app_instance_user method. boto3 documentation

# describe_channel_moderated_by_app_instance_user method definition

def describe_channel_moderated_by_app_instance_user(
    self,
    *,
    ChannelArn: str,
    AppInstanceUserArn: str,
    ChimeBearer: str,
) -> DescribeChannelModeratedByAppInstanceUserResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelModeratedByAppInstanceUserResponseTypeDef 
# describe_channel_moderated_by_app_instance_user method usage example with argument unpacking

kwargs: DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "AppInstanceUserArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_moderated_by_app_instance_user(**kwargs)
  1. See DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef

describe_channel_moderator#

Returns the full details of a single ChannelModerator.

Type annotations and code completion for boto3.client("chime-sdk-messaging").describe_channel_moderator method. boto3 documentation

# describe_channel_moderator method definition

def describe_channel_moderator(
    self,
    *,
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,
) -> DescribeChannelModeratorResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelModeratorResponseTypeDef 
# describe_channel_moderator method usage example with argument unpacking

kwargs: DescribeChannelModeratorRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelModeratorArn": ...,
    "ChimeBearer": ...,
}

parent.describe_channel_moderator(**kwargs)
  1. See DescribeChannelModeratorRequestRequestTypeDef

disassociate_channel_flow#

Disassociates a channel flow from all its channels.

Type annotations and code completion for boto3.client("chime-sdk-messaging").disassociate_channel_flow method. boto3 documentation

# disassociate_channel_flow method definition

def disassociate_channel_flow(
    self,
    *,
    ChannelArn: str,
    ChannelFlowArn: str,
    ChimeBearer: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# disassociate_channel_flow method usage example with argument unpacking

kwargs: DisassociateChannelFlowRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "ChannelFlowArn": ...,
    "ChimeBearer": ...,
}

parent.disassociate_channel_flow(**kwargs)
  1. See DisassociateChannelFlowRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("chime-sdk-messaging").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_channel_membership_preferences#

Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel.

Type annotations and code completion for boto3.client("chime-sdk-messaging").get_channel_membership_preferences method. boto3 documentation

# get_channel_membership_preferences method definition

def get_channel_membership_preferences(
    self,
    *,
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
) -> GetChannelMembershipPreferencesResponseTypeDef:  # (1)
    ...
  1. See GetChannelMembershipPreferencesResponseTypeDef 
# get_channel_membership_preferences method usage example with argument unpacking

kwargs: GetChannelMembershipPreferencesRequestRequestTypeDef = {  # (1)
    "ChannelArn": ...,
    "MemberArn": ...,
    "ChimeBearer": ...,
}

parent.get_channel_membership_preferences(**kwargs)
  1. See GetChannelMembershipPreferencesRequestRequestTypeDef

get_channel_message#

Gets the full details of a channel message.

Type annotations and code completion for boto3.client("chime-sdk-messaging").get_channel_message method. boto3 documentation

# get_channel_message method definition

def get_channel_message(
    self,
    *,
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: str = ...,
) -> GetChannelMessageResponseTypeDef:  # (1)
    ...
  1. See GetChannelMessageResponseTypeDef 
<