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
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.
client = boto3.client("chime")
try:
do_something(client)
except (
client.AccessDeniedException,
client.BadRequestException,
client.ClientError,
client.ConflictException,
client.ForbiddenException,
client.NotFoundException,
client.ResourceLimitExceededException,
client.ServiceFailureException,
client.ServiceUnavailableException,
client.ThrottledClientException,
client.UnauthorizedClientException,
client.UnprocessableEntityException,
) as e:
print(e)
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
def associate_phone_number_with_user(
self,
*,
AccountId: str,
UserId: str,
E164PhoneNumber: str,
) -> Dict[str, Any]:
...
kwargs: AssociatePhoneNumberWithUserRequestRequestTypeDef = { # (1)
"AccountId": ...,
"UserId": ...,
"E164PhoneNumber": ...,
}
parent.associate_phone_number_with_user(**kwargs)
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
def associate_phone_numbers_with_voice_connector(
self,
*,
VoiceConnectorId: str,
E164PhoneNumbers: Sequence[str],
ForceAssociate: bool = ...,
) -> AssociatePhoneNumbersWithVoiceConnectorResponseTypeDef: # (1)
...
kwargs: AssociatePhoneNumbersWithVoiceConnectorRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"E164PhoneNumbers": ...,
}
parent.associate_phone_numbers_with_voice_connector(**kwargs)
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
def associate_phone_numbers_with_voice_connector_group(
self,
*,
VoiceConnectorGroupId: str,
E164PhoneNumbers: Sequence[str],
ForceAssociate: bool = ...,
) -> AssociatePhoneNumbersWithVoiceConnectorGroupResponseTypeDef: # (1)
...
kwargs: AssociatePhoneNumbersWithVoiceConnectorGroupRequestRequestTypeDef = { # (1)
"VoiceConnectorGroupId": ...,
"E164PhoneNumbers": ...,
}
parent.associate_phone_numbers_with_voice_connector_group(**kwargs)
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
def associate_signin_delegate_groups_with_account(
self,
*,
AccountId: str,
SigninDelegateGroups: Sequence[SigninDelegateGroupTypeDef], # (1)
) -> Dict[str, Any]:
...
kwargs: AssociateSigninDelegateGroupsWithAccountRequestRequestTypeDef = { # (1)
"AccountId": ...,
"SigninDelegateGroups": ...,
}
parent.associate_signin_delegate_groups_with_account(**kwargs)
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
def batch_create_attendee(
self,
*,
MeetingId: str,
Attendees: Sequence[CreateAttendeeRequestItemTypeDef], # (1)
) -> BatchCreateAttendeeResponseTypeDef: # (2)
...
kwargs: BatchCreateAttendeeRequestRequestTypeDef = { # (1)
"MeetingId": ...,
"Attendees": ...,
}
parent.batch_create_attendee(**kwargs)
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
def batch_create_channel_membership(
self,
*,
ChannelArn: str,
MemberArns: Sequence[str],
Type: ChannelMembershipTypeType = ..., # (1)
ChimeBearer: str = ...,
) -> BatchCreateChannelMembershipResponseTypeDef: # (2)
...
kwargs: BatchCreateChannelMembershipRequestRequestTypeDef = { # (1)
"ChannelArn": ...,
"MemberArns": ...,
}
parent.batch_create_channel_membership(**kwargs)
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
def batch_create_room_membership(
self,
*,
AccountId: str,
RoomId: str,
MembershipItemList: Sequence[MembershipItemTypeDef], # (1)
) -> BatchCreateRoomMembershipResponseTypeDef: # (2)
...
kwargs: BatchCreateRoomMembershipRequestRequestTypeDef = { # (1)
"AccountId": ...,
"RoomId": ...,
"MembershipItemList": ...,
}
parent.batch_create_room_membership(**kwargs)
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
def batch_delete_phone_number(
self,
*,
PhoneNumberIds: Sequence[str],
) -> BatchDeletePhoneNumberResponseTypeDef: # (1)
...
kwargs: BatchDeletePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberIds": ...,
}
parent.batch_delete_phone_number(**kwargs)
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
def batch_suspend_user(
self,
*,
AccountId: str,
UserIdList: Sequence[str],
) -> BatchSuspendUserResponseTypeDef: # (1)
...
kwargs: BatchSuspendUserRequestRequestTypeDef = { # (1)
"AccountId": ...,
"UserIdList": ...,
}
parent.batch_suspend_user(**kwargs)
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
def batch_unsuspend_user(
self,
*,
AccountId: str,
UserIdList: Sequence[str],
) -> BatchUnsuspendUserResponseTypeDef: # (1)
...
kwargs: BatchUnsuspendUserRequestRequestTypeDef = { # (1)
"AccountId": ...,
"UserIdList": ...,
}
parent.batch_unsuspend_user(**kwargs)
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
def batch_update_phone_number(
self,
*,
UpdatePhoneNumberRequestItems: Sequence[UpdatePhoneNumberRequestItemTypeDef], # (1)
) -> BatchUpdatePhoneNumberResponseTypeDef: # (2)
...
kwargs: BatchUpdatePhoneNumberRequestRequestTypeDef = { # (1)
"UpdatePhoneNumberRequestItems": ...,
}
parent.batch_update_phone_number(**kwargs)
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
def batch_update_user(
self,
*,
AccountId: str,
UpdateUserRequestItems: Sequence[UpdateUserRequestItemTypeDef], # (1)
) -> BatchUpdateUserResponseTypeDef: # (2)
...
kwargs: BatchUpdateUserRequestRequestTypeDef = { # (1)
"AccountId": ...,
"UpdateUserRequestItems": ...,
}
parent.batch_update_user(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("chime").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("chime").close
method.
boto3 documentation
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
def create_account(
self,
*,
Name: str,
) -> CreateAccountResponseTypeDef: # (1)
...
kwargs: CreateAccountRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_account(**kwargs)
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
def create_app_instance(
self,
*,
Name: str,
ClientRequestToken: str,
Metadata: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAppInstanceResponseTypeDef: # (2)
...
kwargs: CreateAppInstanceRequestRequestTypeDef = { # (1)
"Name": ...,
"ClientRequestToken": ...,
}
parent.create_app_instance(**kwargs)
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
def create_app_instance_admin(
self,
*,
AppInstanceAdminArn: str,
AppInstanceArn: str,
) -> CreateAppInstanceAdminResponseTypeDef: # (1)
...
kwargs: CreateAppInstanceAdminRequestRequestTypeDef = { # (1)
"AppInstanceAdminArn": ...,
"AppInstanceArn": ...,
}
parent.create_app_instance_admin(**kwargs)
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
def create_app_instance_user(
self,
*,
AppInstanceArn: str,
AppInstanceUserId: str,
Name: str,
ClientRequestToken: str,
Metadata: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAppInstanceUserResponseTypeDef: # (2)
...
kwargs: CreateAppInstanceUserRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
"AppInstanceUserId": ...,
"Name": ...,
"ClientRequestToken": ...,
}
parent.create_app_instance_user(**kwargs)
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
def create_attendee(
self,
*,
MeetingId: str,
ExternalUserId: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateAttendeeResponseTypeDef: # (2)
...
kwargs: CreateAttendeeRequestRequestTypeDef = { # (1)
"MeetingId": ...,
"ExternalUserId": ...,
}
parent.create_attendee(**kwargs)
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
def create_bot(
self,
*,
AccountId: str,
DisplayName: str,
Domain: str = ...,
) -> CreateBotResponseTypeDef: # (1)
...
kwargs: CreateBotRequestRequestTypeDef = { # (1)
"AccountId": ...,
"DisplayName": ...,
}
parent.create_bot(**kwargs)
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
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)
...
- See ChannelModeType
- See ChannelPrivacyType
- See TagTypeDef
- See CreateChannelResponseTypeDef
kwargs: CreateChannelRequestRequestTypeDef = { # (1)
"AppInstanceArn": ...,
"Name": ...,
"ClientRequestToken": ...,
}
parent.create_channel(**kwargs)
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
def create_channel_ban(
self,
*,
ChannelArn: str,
MemberArn: str,
ChimeBearer: str = ...,
) -> CreateChannelBanResponseTypeDef: # (1)
...
kwargs: CreateChannelBanRequestRequestTypeDef = { # (1)
"ChannelArn": ...,
"MemberArn": ...,
}
parent.create_channel_ban(**kwargs)
create_channel_membership
Adds a user to a channel.
Type annotations and code completion for boto3.client("chime").create_channel_membership
method.
boto3 documentation
def create_channel_membership(
self,
*,
ChannelArn: str,
MemberArn: str,
Type: ChannelMembershipTypeType, # (1)
ChimeBearer: str = ...,
) -> CreateChannelMembershipResponseTypeDef: # (2)
...
kwargs: CreateChannelMembershipRequestRequestTypeDef = { # (1)
"ChannelArn": ...,
"MemberArn": ...,
"Type": ...,
}
parent.create_channel_membership(**kwargs)
create_channel_moderator
Creates a new ChannelModerator
.
Type annotations and code completion for boto3.client("chime").create_channel_moderator
method.
boto3 documentation
def create_channel_moderator(
self,
*,
ChannelArn: str,
ChannelModeratorArn: str,
ChimeBearer: str = ...,
) -> CreateChannelModeratorResponseTypeDef: # (1)
...
kwargs: CreateChannelModeratorRequestRequestTypeDef = { # (1)
"ChannelArn": ...,
"ChannelModeratorArn": ...,
}
parent.create_channel_moderator(**kwargs)
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
def create_media_capture_pipeline(
self,
*,
SourceType: MediaPipelineSourceTypeType, # (1)
SourceArn: str,
SinkType: MediaPipelineSinkTypeType, # (2)
SinkArn: str,
ClientRequestToken: str = ...,
ChimeSdkMeetingConfiguration: ChimeSdkMeetingConfigurationTypeDef = ..., # (3)
) -> CreateMediaCapturePipelineResponseTypeDef: # (4)
...
- See MediaPipelineSourceTypeType
- See MediaPipelineSinkTypeType
- See ChimeSdkMeetingConfigurationTypeDef
- See CreateMediaCapturePipelineResponseTypeDef
kwargs: CreateMediaCapturePipelineRequestRequestTypeDef = { # (1)
"SourceType": ...,
"SourceArn": ...,
"SinkType": ...,
"SinkArn": ...,
}
parent.create_media_capture_pipeline(**kwargs)
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
def create_meeting(
self,
*,
ClientRequestToken: str,
ExternalMeetingId: str = ...,
MeetingHostId: str = ...,
MediaRegion: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
NotificationsConfiguration: MeetingNotificationConfigurationTypeDef = ..., # (2)
) -> CreateMeetingResponseTypeDef: # (3)
...
kwargs: CreateMeetingRequestRequestTypeDef = { # (1)
"ClientRequestToken": ...,
}
parent.create_meeting(**kwargs)
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
def create_meeting_dial_out(
self,
*,
MeetingId: str,
FromPhoneNumber: str,
ToPhoneNumber: str,
JoinToken: str,
) -> CreateMeetingDialOutResponseTypeDef: # (1)
...
kwargs: CreateMeetingDialOutRequestRequestTypeDef = { # (1)
"MeetingId": ...,
"FromPhoneNumber": ...,
"ToPhoneNumber": ...,
"JoinToken": ...,
}
parent.create_meeting_dial_out(**kwargs)
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
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)
...
- See TagTypeDef
- See MeetingNotificationConfigurationTypeDef
- See CreateAttendeeRequestItemTypeDef
- See CreateMeetingWithAttendeesResponseTypeDef
kwargs: CreateMeetingWithAttendeesRequestRequestTypeDef = { # (1)
"ClientRequestToken": ...,
}
parent.create_meeting_with_attendees(**kwargs)
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
def create_phone_number_order(
self,
*,
ProductType: PhoneNumberProductTypeType, # (1)
E164PhoneNumbers: Sequence[str],
) -> CreatePhoneNumberOrderResponseTypeDef: # (2)
...
kwargs: CreatePhoneNumberOrderRequestRequestTypeDef = { # (1)
"ProductType": ...,
"E164PhoneNumbers": ...,
}
parent.create_phone_number_order(**kwargs)
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
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)
...
- See CapabilityType
- See NumberSelectionBehaviorType
- See GeoMatchLevelType
- See GeoMatchParamsTypeDef
- See CreateProxySessionResponseTypeDef
kwargs: CreateProxySessionRequestRequestTypeDef = { # (1)
"VoiceConnectorId": ...,
"ParticipantPhoneNumbers": ...,
"Capabilities": ...,
}
parent.create_proxy_session(**kwargs)
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
def create_room(
self,
*,
AccountId: str,
Name: str,
ClientRequestToken: str = ...,
) -> CreateRoomResponseTypeDef: # (1)
...
kwargs: CreateRoomRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Name": ...,
}
parent.create_room(**kwargs)
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
def create_room_membership(
self,
*,
AccountId: str,
RoomId: str,
MemberId: str,
Role: RoomMembershipRoleType = ..., # (1)
) -> CreateRoomMembershipResponseTypeDef: # (2)
...
kwargs: CreateRoomMembershipRequestRequestTypeDef = { # (1)
"AccountId": ...,
"RoomId": ...,
"MemberId": ...,
}
parent.create_room_membership(**kwargs)
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
def create_sip_media_application(
self,
*,
AwsRegion: str,
Name: str,
Endpoints: Sequence[SipMediaApplicationEndpointTypeDef], # (1)
) -> CreateSipMediaApplicationResponseTypeDef: # (2)
...
kwargs: CreateSipMediaApplicationRequestRequestTypeDef = { # (1)
"AwsRegion": ...,
"Name": ...,
"Endpoints": ...,
}
parent.create_sip_media_application(**kwargs)
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
def create_sip_media_application_call(
self,
*,
FromPhoneNumber: str,
ToPhoneNumber: str,
SipMediaApplicationId: str,
SipHeaders: Mapping[str, str] = ...,
) -> CreateSipMediaApplicationCallResponseTypeDef: # (1)
...
kwargs: CreateSipMediaApplicationCallRequestRequestTypeDef = { # (1)
"FromPhoneNumber": ...,
"ToPhoneNumber": ...,
"SipMediaApplicationId": ...,
}
parent.create_sip_media_application_call(**kwargs)
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
def create_sip_rule(
self,
*,
Name: str,
TriggerType: SipRuleTriggerTypeType, # (1)
TriggerValue: str,
TargetApplications: Sequence[SipRuleTargetApplicationTypeDef], # (2)
Disabled: bool = ...,
) -> CreateSipRuleResponseTypeDef: # (3)
...
kwargs: CreateSipRuleRequestRequestTypeDef = { # (1)
"Name": ...,
"TriggerType": ...,
"TriggerValue": ...,
"TargetApplications": ...,
}
parent.create_sip_rule(**kwargs)
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
def create_user(
self,
*,
AccountId: str,
Username: str = ...,
Email: str = ...,
UserType: UserTypeType = ..., # (1)
) -> CreateUserResponseTypeDef: # (2)
...
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.create_user(**kwargs)
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
def create_voice_connector(
self,
*,
Name: str,
RequireEncryption: bool,
AwsRegion: VoiceConnectorAwsRegionType = ..., # (1)
) -> CreateVoiceConnectorResponseTypeDef: # (2)
...
kwargs: CreateVoiceConnectorRequestRequestTypeDef = { # (1)
"Name": ...,
"RequireEncryption": ...,
}
parent.create_voice_connector(**kwargs)
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.