Skip to content

ChimeClient#

Index > Chime > ChimeClient

Auto-generated documentation for Chime type annotations stubs module mypy-boto3-chime.

ChimeClient#

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

# ChimeClient usage example

from boto3.session import Session
from mypy_boto3_chime.client import ChimeClient

def get_chime_client() -> ChimeClient:
    return Session().client("chime")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("chime")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    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,
    client.exceptions.UnprocessableEntityException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_chime.client import Exceptions

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

Methods#

associate_phone_number_with_user#

Associates a phone number with the specified Amazon Chime user.

Type annotations and code completion for boto3.client("chime").associate_phone_number_with_user method. boto3 documentation

# associate_phone_number_with_user method definition

def associate_phone_number_with_user(
    self,
    *,
    AccountId: str,
    UserId: str,
    E164PhoneNumber: str,
) -> Dict[str, Any]:
    ...
# associate_phone_number_with_user method usage example with argument unpacking

kwargs: AssociatePhoneNumberWithUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserId": ...,
    "E164PhoneNumber": ...,
}

parent.associate_phone_number_with_user(**kwargs)
  1. See AssociatePhoneNumberWithUserRequestRequestTypeDef

associate_phone_numbers_with_voice_connector#

Associates phone numbers with the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").associate_phone_numbers_with_voice_connector method. boto3 documentation

# associate_phone_numbers_with_voice_connector method definition

def associate_phone_numbers_with_voice_connector(
    self,
    *,
    VoiceConnectorId: str,
    E164PhoneNumbers: Sequence[str],
    ForceAssociate: bool = ...,
) -> AssociatePhoneNumbersWithVoiceConnectorResponseTypeDef:  # (1)
    ...
  1. See AssociatePhoneNumbersWithVoiceConnectorResponseTypeDef 
# associate_phone_numbers_with_voice_connector method usage example with argument unpacking

kwargs: AssociatePhoneNumbersWithVoiceConnectorRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "E164PhoneNumbers": ...,
}

parent.associate_phone_numbers_with_voice_connector(**kwargs)
  1. See AssociatePhoneNumbersWithVoiceConnectorRequestRequestTypeDef

associate_phone_numbers_with_voice_connector_group#

Associates phone numbers with the specified Amazon Chime Voice Connector group.

Type annotations and code completion for boto3.client("chime").associate_phone_numbers_with_voice_connector_group method. boto3 documentation

# associate_phone_numbers_with_voice_connector_group method definition

def associate_phone_numbers_with_voice_connector_group(
    self,
    *,
    VoiceConnectorGroupId: str,
    E164PhoneNumbers: Sequence[str],
    ForceAssociate: bool = ...,
) -> AssociatePhoneNumbersWithVoiceConnectorGroupResponseTypeDef:  # (1)
    ...
  1. See AssociatePhoneNumbersWithVoiceConnectorGroupResponseTypeDef 
# associate_phone_numbers_with_voice_connector_group method usage example with argument unpacking

kwargs: AssociatePhoneNumbersWithVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "VoiceConnectorGroupId": ...,
    "E164PhoneNumbers": ...,
}

parent.associate_phone_numbers_with_voice_connector_group(**kwargs)
  1. See AssociatePhoneNumbersWithVoiceConnectorGroupRequestRequestTypeDef

associate_signin_delegate_groups_with_account#

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").associate_signin_delegate_groups_with_account method. boto3 documentation

# associate_signin_delegate_groups_with_account method definition

def associate_signin_delegate_groups_with_account(
    self,
    *,
    AccountId: str,
    SigninDelegateGroups: Sequence[SigninDelegateGroupTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See SigninDelegateGroupTypeDef 
# associate_signin_delegate_groups_with_account method usage example with argument unpacking

kwargs: AssociateSigninDelegateGroupsWithAccountRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "SigninDelegateGroups": ...,
}

parent.associate_signin_delegate_groups_with_account(**kwargs)
  1. See AssociateSigninDelegateGroupsWithAccountRequestRequestTypeDef

batch_create_attendee#

Creates up to 100 new attendees for an active Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").batch_create_attendee method. boto3 documentation

# batch_create_attendee method definition

def batch_create_attendee(
    self,
    *,
    MeetingId: str,
    Attendees: Sequence[CreateAttendeeRequestItemTypeDef],  # (1)
) -> BatchCreateAttendeeResponseTypeDef:  # (2)
    ...
  1. See CreateAttendeeRequestItemTypeDef
  2. See BatchCreateAttendeeResponseTypeDef 
# batch_create_attendee method usage example with argument unpacking

kwargs: BatchCreateAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "Attendees": ...,
}

parent.batch_create_attendee(**kwargs)
  1. See BatchCreateAttendeeRequestRequestTypeDef

batch_create_channel_membership#

Adds a specified number of users to a channel.

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

# batch_create_channel_membership method definition

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

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

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

batch_create_room_membership#

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").batch_create_room_membership method. boto3 documentation

# batch_create_room_membership method definition

def batch_create_room_membership(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MembershipItemList: Sequence[MembershipItemTypeDef],  # (1)
) -> BatchCreateRoomMembershipResponseTypeDef:  # (2)
    ...
  1. See MembershipItemTypeDef
  2. See BatchCreateRoomMembershipResponseTypeDef 
# batch_create_room_membership method usage example with argument unpacking

kwargs: BatchCreateRoomMembershipRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MembershipItemList": ...,
}

parent.batch_create_room_membership(**kwargs)
  1. See BatchCreateRoomMembershipRequestRequestTypeDef

batch_delete_phone_number#

Moves phone numbers into the Deletion queue.

Type annotations and code completion for boto3.client("chime").batch_delete_phone_number method. boto3 documentation

# batch_delete_phone_number method definition

def batch_delete_phone_number(
    self,
    *,
    PhoneNumberIds: Sequence[str],
) -> BatchDeletePhoneNumberResponseTypeDef:  # (1)
    ...
  1. See BatchDeletePhoneNumberResponseTypeDef 
# batch_delete_phone_number method usage example with argument unpacking

kwargs: BatchDeletePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberIds": ...,
}

parent.batch_delete_phone_number(**kwargs)
  1. See BatchDeletePhoneNumberRequestRequestTypeDef

batch_suspend_user#

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account.

Type annotations and code completion for boto3.client("chime").batch_suspend_user method. boto3 documentation

# batch_suspend_user method definition

def batch_suspend_user(
    self,
    *,
    AccountId: str,
    UserIdList: Sequence[str],
) -> BatchSuspendUserResponseTypeDef:  # (1)
    ...
  1. See BatchSuspendUserResponseTypeDef 
# batch_suspend_user method usage example with argument unpacking

kwargs: BatchSuspendUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserIdList": ...,
}

parent.batch_suspend_user(**kwargs)
  1. See BatchSuspendUserRequestRequestTypeDef

batch_unsuspend_user#

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account.

Type annotations and code completion for boto3.client("chime").batch_unsuspend_user method. boto3 documentation

# batch_unsuspend_user method definition

def batch_unsuspend_user(
    self,
    *,
    AccountId: str,
    UserIdList: Sequence[str],
) -> BatchUnsuspendUserResponseTypeDef:  # (1)
    ...
  1. See BatchUnsuspendUserResponseTypeDef 
# batch_unsuspend_user method usage example with argument unpacking

kwargs: BatchUnsuspendUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UserIdList": ...,
}

parent.batch_unsuspend_user(**kwargs)
  1. See BatchUnsuspendUserRequestRequestTypeDef

batch_update_phone_number#

Updates phone number product types or calling names.

Type annotations and code completion for boto3.client("chime").batch_update_phone_number method. boto3 documentation

# batch_update_phone_number method definition

def batch_update_phone_number(
    self,
    *,
    UpdatePhoneNumberRequestItems: Sequence[UpdatePhoneNumberRequestItemTypeDef],  # (1)
) -> BatchUpdatePhoneNumberResponseTypeDef:  # (2)
    ...
  1. See UpdatePhoneNumberRequestItemTypeDef
  2. See BatchUpdatePhoneNumberResponseTypeDef 
# batch_update_phone_number method usage example with argument unpacking

kwargs: BatchUpdatePhoneNumberRequestRequestTypeDef = {  # (1)
    "UpdatePhoneNumberRequestItems": ...,
}

parent.batch_update_phone_number(**kwargs)
  1. See BatchUpdatePhoneNumberRequestRequestTypeDef

batch_update_user#

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").batch_update_user method. boto3 documentation

# batch_update_user method definition

def batch_update_user(
    self,
    *,
    AccountId: str,
    UpdateUserRequestItems: Sequence[UpdateUserRequestItemTypeDef],  # (1)
) -> BatchUpdateUserResponseTypeDef:  # (2)
    ...
  1. See UpdateUserRequestItemTypeDef
  2. See BatchUpdateUserResponseTypeDef 
# batch_update_user method usage example with argument unpacking

kwargs: BatchUpdateUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "UpdateUserRequestItems": ...,
}

parent.batch_update_user(**kwargs)
  1. See BatchUpdateUserRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_account#

Creates an Amazon Chime account under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").create_account method. boto3 documentation

# create_account method definition

def create_account(
    self,
    *,
    Name: str,
) -> CreateAccountResponseTypeDef:  # (1)
    ...
  1. See CreateAccountResponseTypeDef 
# create_account method usage example with argument unpacking

kwargs: CreateAccountRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_account(**kwargs)
  1. See CreateAccountRequestRequestTypeDef

create_app_instance#

Creates an Amazon Chime SDK messaging AppInstance under an AWS account.

Type annotations and code completion for boto3.client("chime").create_app_instance method. boto3 documentation

# create_app_instance method definition

def create_app_instance(
    self,
    *,
    Name: str,
    ClientRequestToken: str,
    Metadata: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAppInstanceResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateAppInstanceResponseTypeDef 
# create_app_instance method usage example with argument unpacking

kwargs: CreateAppInstanceRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ClientRequestToken": ...,
}

parent.create_app_instance(**kwargs)
  1. See CreateAppInstanceRequestRequestTypeDef

create_app_instance_admin#

Promotes an AppInstanceUser to an AppInstanceAdmin.

Type annotations and code completion for boto3.client("chime").create_app_instance_admin method. boto3 documentation

# create_app_instance_admin method definition

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

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

parent.create_app_instance_admin(**kwargs)
  1. See CreateAppInstanceAdminRequestRequestTypeDef

create_app_instance_user#

Creates a user under an Amazon Chime AppInstance.

Type annotations and code completion for boto3.client("chime").create_app_instance_user method. boto3 documentation

# create_app_instance_user method definition

def create_app_instance_user(
    self,
    *,
    AppInstanceArn: str,
    AppInstanceUserId: str,
    Name: str,
    ClientRequestToken: str,
    Metadata: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAppInstanceUserResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateAppInstanceUserResponseTypeDef 
# create_app_instance_user method usage example with argument unpacking

kwargs: CreateAppInstanceUserRequestRequestTypeDef = {  # (1)
    "AppInstanceArn": ...,
    "AppInstanceUserId": ...,
    "Name": ...,
    "ClientRequestToken": ...,
}

parent.create_app_instance_user(**kwargs)
  1. See CreateAppInstanceUserRequestRequestTypeDef

create_attendee#

Creates a new attendee for an active Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").create_attendee method. boto3 documentation

# create_attendee method definition

def create_attendee(
    self,
    *,
    MeetingId: str,
    ExternalUserId: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAttendeeResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateAttendeeResponseTypeDef 
# create_attendee method usage example with argument unpacking

kwargs: CreateAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "ExternalUserId": ...,
}

parent.create_attendee(**kwargs)
  1. See CreateAttendeeRequestRequestTypeDef

create_bot#

Creates a bot for an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").create_bot method. boto3 documentation

# create_bot method definition

def create_bot(
    self,
    *,
    AccountId: str,
    DisplayName: str,
    Domain: str = ...,
) -> CreateBotResponseTypeDef:  # (1)
    ...
  1. See CreateBotResponseTypeDef 
# create_bot method usage example with argument unpacking

kwargs: CreateBotRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "DisplayName": ...,
}

parent.create_bot(**kwargs)
  1. See CreateBotRequestRequestTypeDef

create_channel#

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

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

# create_channel method definition

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

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

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").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": ...,
}

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

create_channel_membership#

Adds a user to a channel.

Type annotations and code completion for boto3.client("chime").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 = ...,
) -> CreateChannelMembershipResponseTypeDef:  # (2)
    ...
  1. See ChannelMembershipTypeType
  2. See CreateChannelMembershipResponseTypeDef 
# create_channel_membership method usage example with argument unpacking

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

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

create_channel_moderator#

Creates a new ChannelModerator.

Type annotations and code completion for boto3.client("chime").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": ...,
}

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

create_media_capture_pipeline#

Creates a media capture pipeline.

Type annotations and code completion for boto3.client("chime").create_media_capture_pipeline method. boto3 documentation

# create_media_capture_pipeline method definition

def create_media_capture_pipeline(
    self,
    *,
    SourceType: MediaPipelineSourceTypeType,  # (1)
    SourceArn: str,
    SinkType: MediaPipelineSinkTypeType,  # (2)
    SinkArn: str,
    ClientRequestToken: str = ...,
    ChimeSdkMeetingConfiguration: ChimeSdkMeetingConfigurationTypeDef = ...,  # (3)
) -> CreateMediaCapturePipelineResponseTypeDef:  # (4)
    ...
  1. See MediaPipelineSourceTypeType
  2. See MediaPipelineSinkTypeType
  3. See ChimeSdkMeetingConfigurationTypeDef
  4. See CreateMediaCapturePipelineResponseTypeDef 
# create_media_capture_pipeline method usage example with argument unpacking

kwargs: CreateMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "SourceType": ...,
    "SourceArn": ...,
    "SinkType": ...,
    "SinkArn": ...,
}

parent.create_media_capture_pipeline(**kwargs)
  1. See CreateMediaCapturePipelineRequestRequestTypeDef

create_meeting#

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.

Type annotations and code completion for boto3.client("chime").create_meeting method. boto3 documentation

# create_meeting method definition

def create_meeting(
    self,
    *,
    ClientRequestToken: str,
    ExternalMeetingId: str = ...,
    MeetingHostId: str = ...,
    MediaRegion: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    NotificationsConfiguration: MeetingNotificationConfigurationTypeDef = ...,  # (2)
) -> CreateMeetingResponseTypeDef:  # (3)
    ...
  1. See TagTypeDef
  2. See MeetingNotificationConfigurationTypeDef
  3. See CreateMeetingResponseTypeDef 
# create_meeting method usage example with argument unpacking

kwargs: CreateMeetingRequestRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
}

parent.create_meeting(**kwargs)
  1. See CreateMeetingRequestRequestTypeDef

create_meeting_dial_out#

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting.

Type annotations and code completion for boto3.client("chime").create_meeting_dial_out method. boto3 documentation

# create_meeting_dial_out method definition

def create_meeting_dial_out(
    self,
    *,
    MeetingId: str,
    FromPhoneNumber: str,
    ToPhoneNumber: str,
    JoinToken: str,
) -> CreateMeetingDialOutResponseTypeDef:  # (1)
    ...
  1. See CreateMeetingDialOutResponseTypeDef 
# create_meeting_dial_out method usage example with argument unpacking

kwargs: CreateMeetingDialOutRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "FromPhoneNumber": ...,
    "ToPhoneNumber": ...,
    "JoinToken": ...,
}

parent.create_meeting_dial_out(**kwargs)
  1. See CreateMeetingDialOutRequestRequestTypeDef

create_meeting_with_attendees#

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.

Type annotations and code completion for boto3.client("chime").create_meeting_with_attendees method. boto3 documentation

# create_meeting_with_attendees method definition

def create_meeting_with_attendees(
    self,
    *,
    ClientRequestToken: str,
    ExternalMeetingId: str = ...,
    MeetingHostId: str = ...,
    MediaRegion: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    NotificationsConfiguration: MeetingNotificationConfigurationTypeDef = ...,  # (2)
    Attendees: Sequence[CreateAttendeeRequestItemTypeDef] = ...,  # (3)
) -> CreateMeetingWithAttendeesResponseTypeDef:  # (4)
    ...
  1. See TagTypeDef
  2. See MeetingNotificationConfigurationTypeDef
  3. See CreateAttendeeRequestItemTypeDef
  4. See CreateMeetingWithAttendeesResponseTypeDef 
# create_meeting_with_attendees method usage example with argument unpacking

kwargs: CreateMeetingWithAttendeesRequestRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
}

parent.create_meeting_with_attendees(**kwargs)
  1. See CreateMeetingWithAttendeesRequestRequestTypeDef

create_phone_number_order#

Creates an order for phone numbers to be provisioned.

Type annotations and code completion for boto3.client("chime").create_phone_number_order method. boto3 documentation

# create_phone_number_order method definition

def create_phone_number_order(
    self,
    *,
    ProductType: PhoneNumberProductTypeType,  # (1)
    E164PhoneNumbers: Sequence[str],
) -> CreatePhoneNumberOrderResponseTypeDef:  # (2)
    ...
  1. See PhoneNumberProductTypeType
  2. See CreatePhoneNumberOrderResponseTypeDef 
# create_phone_number_order method usage example with argument unpacking

kwargs: CreatePhoneNumberOrderRequestRequestTypeDef = {  # (1)
    "ProductType": ...,
    "E164PhoneNumbers": ...,
}

parent.create_phone_number_order(**kwargs)
  1. See CreatePhoneNumberOrderRequestRequestTypeDef

create_proxy_session#

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

Type annotations and code completion for boto3.client("chime").create_proxy_session method. boto3 documentation

# create_proxy_session method definition

def create_proxy_session(
    self,
    *,
    VoiceConnectorId: str,
    ParticipantPhoneNumbers: Sequence[str],
    Capabilities: Sequence[CapabilityType],  # (1)
    Name: str = ...,
    ExpiryMinutes: int = ...,
    NumberSelectionBehavior: NumberSelectionBehaviorType = ...,  # (2)
    GeoMatchLevel: GeoMatchLevelType = ...,  # (3)
    GeoMatchParams: GeoMatchParamsTypeDef = ...,  # (4)
) -> CreateProxySessionResponseTypeDef:  # (5)
    ...
  1. See CapabilityType
  2. See NumberSelectionBehaviorType
  3. See GeoMatchLevelType
  4. See GeoMatchParamsTypeDef
  5. See CreateProxySessionResponseTypeDef 
# create_proxy_session method usage example with argument unpacking

kwargs: CreateProxySessionRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ParticipantPhoneNumbers": ...,
    "Capabilities": ...,
}

parent.create_proxy_session(**kwargs)
  1. See CreateProxySessionRequestRequestTypeDef

create_room#

Creates a chat room for the specified Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").create_room method. boto3 documentation

# create_room method definition

def create_room(
    self,
    *,
    AccountId: str,
    Name: str,
    ClientRequestToken: str = ...,
) -> CreateRoomResponseTypeDef:  # (1)
    ...
  1. See CreateRoomResponseTypeDef 
# create_room method usage example with argument unpacking

kwargs: CreateRoomRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Name": ...,
}

parent.create_room(**kwargs)
  1. See CreateRoomRequestRequestTypeDef

create_room_membership#

Adds a member to a chat room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").create_room_membership method. boto3 documentation

# create_room_membership method definition

def create_room_membership(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MemberId: str,
    Role: RoomMembershipRoleType = ...,  # (1)
) -> CreateRoomMembershipResponseTypeDef:  # (2)
    ...
  1. See RoomMembershipRoleType
  2. See CreateRoomMembershipResponseTypeDef 
# create_room_membership method usage example with argument unpacking

kwargs: CreateRoomMembershipRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
    "MemberId": ...,
}

parent.create_room_membership(**kwargs)
  1. See CreateRoomMembershipRequestRequestTypeDef

create_sip_media_application#

Creates a SIP media application.

Type annotations and code completion for boto3.client("chime").create_sip_media_application method. boto3 documentation

# create_sip_media_application method definition

def create_sip_media_application(
    self,
    *,
    AwsRegion: str,
    Name: str,
    Endpoints: Sequence[SipMediaApplicationEndpointTypeDef],  # (1)
) -> CreateSipMediaApplicationResponseTypeDef:  # (2)
    ...
  1. See SipMediaApplicationEndpointTypeDef
  2. See CreateSipMediaApplicationResponseTypeDef 
# create_sip_media_application method usage example with argument unpacking

kwargs: CreateSipMediaApplicationRequestRequestTypeDef = {  # (1)
    "AwsRegion": ...,
    "Name": ...,
    "Endpoints": ...,
}

parent.create_sip_media_application(**kwargs)
  1. See CreateSipMediaApplicationRequestRequestTypeDef

create_sip_media_application_call#

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Type annotations and code completion for boto3.client("chime").create_sip_media_application_call method. boto3 documentation

# create_sip_media_application_call method definition

def create_sip_media_application_call(
    self,
    *,
    FromPhoneNumber: str,
    ToPhoneNumber: str,
    SipMediaApplicationId: str,
    SipHeaders: Mapping[str, str] = ...,
) -> CreateSipMediaApplicationCallResponseTypeDef:  # (1)
    ...
  1. See CreateSipMediaApplicationCallResponseTypeDef 
# create_sip_media_application_call method usage example with argument unpacking

kwargs: CreateSipMediaApplicationCallRequestRequestTypeDef = {  # (1)
    "FromPhoneNumber": ...,
    "ToPhoneNumber": ...,
    "SipMediaApplicationId": ...,
}

parent.create_sip_media_application_call(**kwargs)
  1. See CreateSipMediaApplicationCallRequestRequestTypeDef

create_sip_rule#

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Type annotations and code completion for boto3.client("chime").create_sip_rule method. boto3 documentation

# create_sip_rule method definition

def create_sip_rule(
    self,
    *,
    Name: str,
    TriggerType: SipRuleTriggerTypeType,  # (1)
    TriggerValue: str,
    TargetApplications: Sequence[SipRuleTargetApplicationTypeDef],  # (2)
    Disabled: bool = ...,
) -> CreateSipRuleResponseTypeDef:  # (3)
    ...
  1. See SipRuleTriggerTypeType
  2. See SipRuleTargetApplicationTypeDef
  3. See CreateSipRuleResponseTypeDef 
# create_sip_rule method usage example with argument unpacking

kwargs: CreateSipRuleRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "TriggerType": ...,
    "TriggerValue": ...,
    "TargetApplications": ...,
}

parent.create_sip_rule(**kwargs)
  1. See CreateSipRuleRequestRequestTypeDef

create_user#

Creates a user under the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    AccountId: str,
    Username: str = ...,
    Email: str = ...,
    UserType: UserTypeType = ...,  # (1)
) -> CreateUserResponseTypeDef:  # (2)
    ...
  1. See UserTypeType
  2. See CreateUserResponseTypeDef 
# create_user method usage example with argument unpacking

kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestRequestTypeDef

create_voice_connector#

Creates an Amazon Chime Voice Connector under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").create_voice_connector method. boto3 documentation

# create_voice_connector method definition

def create_voice_connector(
    self,
    *,
    Name: str,
    RequireEncryption: bool,
    AwsRegion: VoiceConnectorAwsRegionType = ...,  # (1)
) -> CreateVoiceConnectorResponseTypeDef:  # (2)
    ...
  1. See VoiceConnectorAwsRegionType
  2. See CreateVoiceConnectorResponseTypeDef 
# create_voice_connector method usage example with argument unpacking

kwargs: CreateVoiceConnectorRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "RequireEncryption": ...,
}

parent.create_voice_connector(**kwargs)
  1. See CreateVoiceConnectorRequestRequestTypeDef

create_voice_connector_group#

Creates an Amazon Chime Voice Connector group under the administrator's AWS account.

Type annotations and code completion for boto3.client("chime").create_voice_connector_group method. boto3 documentation

# create_voice_connector_group method definition

def create_voice_connector_group(
    self,
    *,
    Name: str,
    VoiceConnectorItems: Sequence[VoiceConnectorItemTypeDef] = ...,  # (1)
) -> CreateVoiceConnectorGroupResponseTypeDef:  # (2)
    ...
  1. See VoiceConnectorItemTypeDef
  2. See CreateVoiceConnectorGroupResponseTypeDef 
# create_voice_connector_group method usage example with argument unpacking

kwargs: CreateVoiceConnectorGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_voice_connector_group(**kwargs)
  1. See CreateVoiceConnectorGroupRequestRequestTypeDef

delete_account#

Deletes the specified Amazon Chime account.

Type annotations and code completion for boto3.client("chime").delete_account method. boto3 documentation

# delete_account method definition

def delete_account(
    self,
    *,
    AccountId: str,
) -> Dict[str, Any]:
    ...
# delete_account method usage example with argument unpacking

kwargs: DeleteAccountRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.delete_account(**kwargs)
  1. See DeleteAccountRequestRequestTypeDef

delete_app_instance#

Deletes an AppInstance and all associated data asynchronously.

Type annotations and code completion for boto3.client("chime").delete_app_instance method. boto3 documentation

# delete_app_instance method definition

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

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

parent.delete_app_instance(**kwargs)
  1. See DeleteAppInstanceRequestRequestTypeDef

delete_app_instance_admin#

Demotes an AppInstanceAdmin to an AppInstanceUser.

Type annotations and code completion for boto3.client("chime").delete_app_instance_admin method. boto3 documentation

# delete_app_instance_admin method definition

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

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

parent.delete_app_instance_admin(**kwargs)
  1. See DeleteAppInstanceAdminRequestRequestTypeDef

delete_app_instance_streaming_configurations#

Deletes the streaming configurations of an AppInstance.

Type annotations and code completion for boto3.client("chime").delete_app_instance_streaming_configurations method. boto3 documentation

# delete_app_instance_streaming_configurations method definition

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

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

parent.delete_app_instance_streaming_configurations(**kwargs)
  1. See DeleteAppInstanceStreamingConfigurationsRequestRequestTypeDef

delete_app_instance_user#

Deletes an AppInstanceUser.

Type annotations and code completion for boto3.client("chime").delete_app_instance_user method. boto3 documentation

# delete_app_instance_user method definition

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

kwargs: DeleteAppInstanceUserRequestRequestTypeDef = {  # (1)
    "AppInstanceUserArn": ...,
}

parent.delete_app_instance_user(**kwargs)
  1. See DeleteAppInstanceUserRequestRequestTypeDef

delete_attendee#

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.

Type annotations and code completion for boto3.client("chime").delete_attendee method. boto3 documentation

# delete_attendee method definition

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

kwargs: DeleteAttendeeRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
    "AttendeeId": ...,
}

parent.delete_attendee(**kwargs)
  1. See DeleteAttendeeRequestRequestTypeDef

delete_channel#

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

Type annotations and code completion for boto3.client("chime").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": ...,
}

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

delete_channel_ban#

Removes a user from a channel's ban list.

Type annotations and code completion for boto3.client("chime").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": ...,
}

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

delete_channel_membership#

Removes a member from a channel.

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

# delete_channel_membership method definition

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

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

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

delete_channel_message#

Deletes a channel message.

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

# delete_channel_message method definition

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

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

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

delete_channel_moderator#

Deletes a channel moderator.

Type annotations and code completion for boto3.client("chime").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": ...,
}

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

delete_events_configuration#

Deletes the events configuration that allows a bot to receive outgoing events.

Type annotations and code completion for boto3.client("chime").delete_events_configuration method. boto3 documentation

# delete_events_configuration method definition

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

kwargs: DeleteEventsConfigurationRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BotId": ...,
}

parent.delete_events_configuration(**kwargs)
  1. See DeleteEventsConfigurationRequestRequestTypeDef

delete_media_capture_pipeline#

Deletes the media capture pipeline.

Type annotations and code completion for boto3.client("chime").delete_media_capture_pipeline method. boto3 documentation

# delete_media_capture_pipeline method definition

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

kwargs: DeleteMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.delete_media_capture_pipeline(**kwargs)
  1. See DeleteMediaCapturePipelineRequestRequestTypeDef

delete_meeting#

Deletes the specified Amazon Chime SDK meeting.

Type annotations and code completion for boto3.client("chime").delete_meeting method. boto3 documentation

# delete_meeting method definition

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

kwargs: DeleteMeetingRequestRequestTypeDef = {  # (1)
    "MeetingId": ...,
}

parent.delete_meeting(**kwargs)
  1. See DeleteMeetingRequestRequestTypeDef

delete_phone_number#

Moves the specified phone number into the Deletion queue.

Type annotations and code completion for boto3.client("chime").delete_phone_number method. boto3 documentation

# delete_phone_number method definition

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

kwargs: DeletePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.delete_phone_number(**kwargs)
  1. See DeletePhoneNumberRequestRequestTypeDef

delete_proxy_session#

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

Type annotations and code completion for boto3.client("chime").delete_proxy_session method. boto3 documentation

# delete_proxy_session method definition

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

kwargs: DeleteProxySessionRequestRequestTypeDef = {  # (1)
    "VoiceConnectorId": ...,
    "ProxySessionId": ...,
}

parent.delete_proxy_session(**kwargs)
  1. See DeleteProxySessionRequestRequestTypeDef

delete_room#

Deletes a chat room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").delete_room method. boto3 documentation

# delete_room method definition

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

kwargs: DeleteRoomRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "RoomId": ...,
}

parent.delete_room(**kwargs)
  1. See DeleteRoomRequestRequestTypeDef

delete_room_membership#

Removes a member from a chat room in an Amazon Chime Enterprise account.

Type annotations and code completion for boto3.client("chime").delete_room_membership method. boto3 documentation

# delete_room_membership method definition

def delete_room_membership(
    self,
    *,
    AccountId: str,
    RoomId: str,
    MemberId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See