{ "version": "2.0", "metadata": { "apiVersion": "2018-05-01", "endpointPrefix": "chime", "protocol": "rest-json", "serviceFullName": "Amazon Chime", "serviceId": "Chime", "signatureVersion": "v4", "uid": "chime-2018-05-01" }, "operations": { "AssociatePhoneNumberWithUser": { "name": "AssociatePhoneNumberWithUser", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/users/{userId}?operation=associate-phone-number", "responseCode": 200 }, "input": { "shape": "AssociatePhoneNumberWithUserRequest" }, "output": { "shape": "AssociatePhoneNumberWithUserResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "
Associates a phone number with the specified Amazon Chime user.
" }, "AssociatePhoneNumbersWithVoiceConnector": { "name": "AssociatePhoneNumbersWithVoiceConnector", "http": { "method": "POST", "requestUri": "/voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers", "responseCode": 200 }, "input": { "shape": "AssociatePhoneNumbersWithVoiceConnectorRequest" }, "output": { "shape": "AssociatePhoneNumbersWithVoiceConnectorResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Associates phone numbers with the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Associates phone numbers with the specified Amazon Chime Voice Connector group.
This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
" }, "BatchCreateAttendee": { "name": "BatchCreateAttendee", "http": { "method": "POST", "requestUri": "/meetings/{meetingId}/attendees?operation=batch-create", "responseCode": 201 }, "input": { "shape": "BatchCreateAttendeeRequest" }, "output": { "shape": "BatchCreateAttendeeResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "NotFoundException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "ThrottledClientException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
", "deprecated": true, "deprecatedMessage": "Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings Namespace" }, "BatchCreateChannelMembership": { "name": "BatchCreateChannelMembership", "http": { "method": "POST", "requestUri": "/channels/{channelArn}/memberships?operation=batch-create", "responseCode": 200 }, "input": { "shape": "BatchCreateChannelMembershipRequest" }, "output": { "shape": "BatchCreateChannelMembershipResponse" }, "errors": [ { "shape": "ServiceFailureException" }, { "shape": "ServiceUnavailableException" }, { "shape": "UnauthorizedClientException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ThrottledClientException" } ], "documentation": "Adds a specified number of users to a channel.
This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
" }, "BatchDeletePhoneNumber": { "name": "BatchDeletePhoneNumber", "http": { "method": "POST", "requestUri": "/phone-numbers?operation=batch-delete", "responseCode": 200 }, "input": { "shape": "BatchDeletePhoneNumberRequest" }, "output": { "shape": "BatchDeletePhoneNumberResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
" }, "BatchSuspendUser": { "name": "BatchSuspendUser", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/users?operation=suspend", "responseCode": 200 }, "input": { "shape": "BatchSuspendUserRequest" }, "output": { "shape": "BatchSuspendUserResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Suspends up to 50 users from a Team
or EnterpriseLWA
Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team
account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team
account users, invite them to the Team
account again. You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA
account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA
account users, use the BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
" }, "BatchUnsuspendUser": { "name": "BatchUnsuspendUser", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/users?operation=unsuspend", "responseCode": 200 }, "input": { "shape": "BatchUnsuspendUserRequest" }, "output": { "shape": "BatchUnsuspendUserResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA
account. Only users on EnterpriseLWA
accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered
status. Users who are not previously suspended are ignored.
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem
. For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
" }, "BatchUpdateUser": { "name": "BatchUpdateUser", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/users", "responseCode": 200 }, "input": { "shape": "BatchUpdateUserRequest" }, "output": { "shape": "BatchUpdateUserResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType
updates are supported for this action.
Creates an Amazon Chime account under the administrator's AWS account. Only Team
account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account. Only SDK messaging customers use this API. CreateAppInstance
supports idempotency behavior as described in the AWS API Standard.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Promotes an AppInstanceUser
to an AppInstanceAdmin
. The promoted user can perform the following actions.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
ChannelModerator
actions across all channels in the AppInstance
.
DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
Creates a user under an Amazon Chime AppInstance
. The request consists of a unique appInstanceUserId
and Name
for that user.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates a bot for an Amazon Chime Enterprise account.
" }, "CreateChannel": { "name": "CreateChannel", "http": { "method": "POST", "requestUri": "/channels", "responseCode": 201 }, "input": { "shape": "CreateChannelRequest" }, "output": { "shape": "CreateChannelResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ConflictException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Adds a user to a channel. The InvitedBy
response field is derived from the request header. A channel member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates a new ChannelModerator
. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates a media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall
action with the corresponding SIP media application ID.
This API is is not available in a dedicated namespace.
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
" }, "CreateProxySession": { "name": "CreateProxySession", "http": { "method": "POST", "requestUri": "/voice-connectors/{voiceConnectorId}/proxy-sessions", "responseCode": 201 }, "input": { "shape": "CreateProxySessionRequest" }, "output": { "shape": "CreateProxySessionResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates a chat room for the specified Amazon Chime Enterprise account.
" }, "CreateRoomMembership": { "name": "CreateRoomMembership", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/rooms/{roomId}/memberships", "responseCode": 201 }, "input": { "shape": "CreateRoomMembershipRequest" }, "output": { "shape": "CreateRoomMembershipResponse" }, "errors": [ { "shape": "ConflictException" }, { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
" }, "CreateSipMediaApplication": { "name": "CreateSipMediaApplication", "http": { "method": "POST", "requestUri": "/sip-media-applications", "responseCode": 201 }, "input": { "shape": "CreateSipMediaApplicationRequest" }, "output": { "shape": "CreateSipMediaApplicationResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "AccessDeniedException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "ConflictException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Creates a SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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
.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates a user under the specified Amazon Chime account.
" }, "CreateVoiceConnector": { "name": "CreateVoiceConnector", "http": { "method": "POST", "requestUri": "/voice-connectors", "responseCode": 201 }, "input": { "shape": "CreateVoiceConnectorRequest" }, "output": { "shape": "CreateVoiceConnectorResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "AccessDeniedException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.
Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems
in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the specified Amazon Chime account. You must suspend all users before deleting Team
account. You can use the BatchSuspendUser action to dodo.
For EnterpriseLWA
and EnterpriseAD
accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled
accounts list for 90 days. To restore deleted account from your Disabled
accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled
accounts list.
Deletes an AppInstance
and all associated data asynchronously.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Demotes an AppInstanceAdmin
to an AppInstanceUser
. This action does not delete the user.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the streaming configurations of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes an AppInstanceUser
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken
. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Removes a user from a channel's ban list.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Removes a member from a channel.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage
.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes a channel moderator.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the events configuration that allows a bot to receive outgoing events.
" }, "DeleteMediaCapturePipeline": { "name": "DeleteMediaCapturePipeline", "http": { "method": "DELETE", "requestUri": "/media-capture-pipelines/{mediaPipelineId}", "responseCode": 204 }, "input": { "shape": "DeleteMediaCapturePipelineRequest" }, "errors": [ { "shape": "ForbiddenException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Deletes the media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMeeting, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
" }, "DeleteProxySession": { "name": "DeleteProxySession", "http": { "method": "DELETE", "requestUri": "/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", "responseCode": 204 }, "input": { "shape": "DeleteProxySessionRequest" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes a chat room in an Amazon Chime Enterprise account.
" }, "DeleteRoomMembership": { "name": "DeleteRoomMembership", "http": { "method": "DELETE", "requestUri": "/accounts/{accountId}/rooms/{roomId}/memberships/{memberId}", "responseCode": 204 }, "input": { "shape": "DeleteRoomMembershipRequest" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Removes a member from a chat room in an Amazon Chime Enterprise account.
" }, "DeleteSipMediaApplication": { "name": "DeleteSipMediaApplication", "http": { "method": "DELETE", "requestUri": "/sip-media-applications/{sipMediaApplicationId}", "responseCode": 204 }, "input": { "shape": "DeleteSipMediaApplicationRequest" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ConflictException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Deletes a SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes a SIP rule. You must disable a SIP rule before you can delete it.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems
and phone numbers associated with the group must be removed before it can be deleted.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the origination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the termination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the full details of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the full details of an AppInstanceAdmin
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the full details of an AppInstanceUser
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the full details of a channel in an Amazon Chime AppInstance
.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the full details of a channel ban.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the full details of a user's channel membership.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the details of a channel based on the membership of the specified AppInstanceUser
.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the full details of a channel moderated by the specified AppInstanceUser
.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the full details of a single ChannelModerator.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
" }, "DisassociatePhoneNumbersFromVoiceConnector": { "name": "DisassociatePhoneNumbersFromVoiceConnector", "http": { "method": "POST", "requestUri": "/voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers", "responseCode": 200 }, "input": { "shape": "DisassociatePhoneNumbersFromVoiceConnectorRequest" }, "output": { "shape": "DisassociatePhoneNumbersFromVoiceConnectorResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
" }, "GetAccount": { "name": "GetAccount", "http": { "method": "GET", "requestUri": "/accounts/{accountId}" }, "input": { "shape": "GetAccountRequest" }, "output": { "shape": "GetAccountResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
" }, "GetAccountSettings": { "name": "GetAccountSettings", "http": { "method": "GET", "requestUri": "/accounts/{accountId}/settings" }, "input": { "shape": "GetAccountSettingsRequest" }, "output": { "shape": "GetAccountSettingsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
" }, "GetAppInstanceRetentionSettings": { "name": "GetAppInstanceRetentionSettings", "http": { "method": "GET", "requestUri": "/app-instances/{appInstanceArn}/retention-settings", "responseCode": 200 }, "input": { "shape": "GetAppInstanceRetentionSettingsRequest" }, "output": { "shape": "GetAppInstanceRetentionSettingsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Gets the retention settings for an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Gets the streaming settings for an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
" }, "GetChannelMessage": { "name": "GetChannelMessage", "http": { "method": "GET", "requestUri": "/channels/{channelArn}/messages/{messageId}", "responseCode": 200 }, "input": { "shape": "GetChannelMessageRequest" }, "output": { "shape": "GetChannelMessageResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "NotFoundException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Gets the full details of a channel message.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
" }, "GetGlobalSettings": { "name": "GetGlobalSettings", "http": { "method": "GET", "requestUri": "/settings", "responseCode": 200 }, "output": { "shape": "GetGlobalSettingsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
" }, "GetMediaCapturePipeline": { "name": "GetMediaCapturePipeline", "http": { "method": "GET", "requestUri": "/media-capture-pipelines/{mediaPipelineId}", "responseCode": 200 }, "input": { "shape": "GetMediaCapturePipelineRequest" }, "output": { "shape": "GetMediaCapturePipelineResponse" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Gets an existing media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .
", "deprecated": true, "deprecatedMessage": "Replaced by GetMeeting in the Amazon Chime SDK Meetings Namespace" }, "GetMessagingSessionEndpoint": { "name": "GetMessagingSessionEndpoint", "http": { "method": "GET", "requestUri": "/endpoints/messaging-session", "responseCode": 200 }, "input": { "shape": "GetMessagingSessionEndpointRequest" }, "output": { "shape": "GetMessagingSessionEndpointResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "ForbiddenException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "The details of the endpoint for the messaging session.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingSessionEndpoint, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
" }, "GetPhoneNumberOrder": { "name": "GetPhoneNumberOrder", "http": { "method": "GET", "requestUri": "/phone-number-orders/{phoneNumberOrderId}", "responseCode": 200 }, "input": { "shape": "GetPhoneNumberOrderRequest" }, "output": { "shape": "GetPhoneNumberOrderResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
" }, "GetPhoneNumberSettings": { "name": "GetPhoneNumberSettings", "http": { "method": "GET", "requestUri": "/settings/phone-number", "responseCode": 200 }, "output": { "shape": "GetPhoneNumberSettingsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
" }, "GetProxySession": { "name": "GetProxySession", "http": { "method": "GET", "requestUri": "/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", "responseCode": 200 }, "input": { "shape": "GetProxySessionRequest" }, "output": { "shape": "GetProxySessionResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
" }, "GetRoom": { "name": "GetRoom", "http": { "method": "GET", "requestUri": "/accounts/{accountId}/rooms/{roomId}", "responseCode": 200 }, "input": { "shape": "GetRoomRequest" }, "output": { "shape": "GetRoomResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "NotFoundException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
" }, "GetSipMediaApplication": { "name": "GetSipMediaApplication", "http": { "method": "GET", "requestUri": "/sip-media-applications/{sipMediaApplicationId}", "responseCode": 200 }, "input": { "shape": "GetSipMediaApplicationRequest" }, "output": { "shape": "GetSipMediaApplicationResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns the logging configuration for the specified SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
" }, "GetUserSettings": { "name": "GetUserSettings", "http": { "method": "GET", "requestUri": "/accounts/{accountId}/users/{userId}/settings", "responseCode": 200 }, "input": { "shape": "GetUserSettingsRequest" }, "output": { "shape": "GetUserSettingsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves settings for the specified user ID, such as any associated phone number settings.
" }, "GetVoiceConnector": { "name": "GetVoiceConnector", "http": { "method": "GET", "requestUri": "/voice-connectors/{voiceConnectorId}", "responseCode": 200 }, "input": { "shape": "GetVoiceConnectorRequest" }, "output": { "shape": "GetVoiceConnectorResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves information about the last time a SIP OPTIONS
ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team
account. Only Team
account types are currently supported for this action.
Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
" }, "ListAppInstanceAdmins": { "name": "ListAppInstanceAdmins", "http": { "method": "GET", "requestUri": "/app-instances/{appInstanceArn}/admins", "responseCode": 200 }, "input": { "shape": "ListAppInstanceAdminsRequest" }, "output": { "shape": "ListAppInstanceAdminsResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ThrottledClientException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Returns a list of the administrators in the AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceAdmins, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
List all AppInstanceUsers
created under a single AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists all Amazon Chime AppInstance
s created under a single AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists the tags applied to an Amazon Chime SDK attendee resource.
ListAttendeeTags is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAttendees, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
" }, "ListChannelBans": { "name": "ListChannelBans", "http": { "method": "GET", "requestUri": "/channels/{channelArn}/bans", "responseCode": 200 }, "input": { "shape": "ListChannelBansRequest" }, "output": { "shape": "ListChannelBansResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Lists all the users banned from a particular channel.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists all channel memberships in a channel.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMemberships, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
List all the messages in a channel. Returns a paginated list of ChannelMessages
. By default, sorted by creation timestamp in descending order.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists all the moderators for a channel.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelModerators, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC
to retrieve all public channels in the account.
Only an AppInstanceAdmin
can set privacy = PRIVATE
to list the private channels in an account.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
A list of the channels moderated by an AppInstanceUser
.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Returns a list of media capture pipelines.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists the tags applied to an Amazon Chime SDK meeting resource.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListTagsForResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists up to 100 active Amazon Chime SDK meetings.
ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
", "deprecated": true, "deprecatedMessage": "ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API." }, "ListPhoneNumberOrders": { "name": "ListPhoneNumberOrders", "http": { "method": "GET", "requestUri": "/phone-number-orders", "responseCode": 200 }, "input": { "shape": "ListPhoneNumberOrdersRequest" }, "output": { "shape": "ListPhoneNumberOrdersResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Lists the phone number orders for the administrator's Amazon Chime account.
" }, "ListPhoneNumbers": { "name": "ListPhoneNumbers", "http": { "method": "GET", "requestUri": "/phone-numbers" }, "input": { "shape": "ListPhoneNumbersRequest" }, "output": { "shape": "ListPhoneNumbersResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "NotFoundException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
" }, "ListProxySessions": { "name": "ListProxySessions", "http": { "method": "GET", "requestUri": "/voice-connectors/{voiceConnectorId}/proxy-sessions", "responseCode": 200 }, "input": { "shape": "ListProxySessionsRequest" }, "output": { "shape": "ListProxySessionsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Lists the proxy sessions for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListProxySessions, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
" }, "ListRooms": { "name": "ListRooms", "http": { "method": "GET", "requestUri": "/accounts/{accountId}/rooms", "responseCode": 200 }, "input": { "shape": "ListRoomsRequest" }, "output": { "shape": "ListRoomsResponse" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
" }, "ListSipMediaApplications": { "name": "ListSipMediaApplications", "http": { "method": "GET", "requestUri": "/sip-media-applications", "responseCode": 200 }, "input": { "shape": "ListSipMediaApplicationsRequest" }, "output": { "shape": "ListSipMediaApplicationsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Lists the SIP media applications under the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipMediaApplications, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists the SIP rules under the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists supported phone number countries.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "GET", "requestUri": "/tags" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "NotFoundException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.
This API is is no longer supported and will not be updated. We recommend using the applicable latest version in the Amazon Chime SDK.
For meetings: ListTagsForResource.
For messaging: ListTagsForResource.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
" }, "ListVoiceConnectorGroups": { "name": "ListVoiceConnectorGroups", "http": { "method": "GET", "requestUri": "/voice-connector-groups", "responseCode": 200 }, "input": { "shape": "ListVoiceConnectorGroupsRequest" }, "output": { "shape": "ListVoiceConnectorGroupsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorGroups, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectors, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Logs out the specified user from all of the devices they are currently logged into.
" }, "PutAppInstanceRetentionSettings": { "name": "PutAppInstanceRetentionSettings", "http": { "method": "PUT", "requestUri": "/app-instances/{appInstanceArn}/retention-settings", "responseCode": 200 }, "input": { "shape": "PutAppInstanceRetentionSettingsRequest" }, "output": { "shape": "PutAppInstanceRetentionSettingsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ConflictException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Sets the amount of time in days that a given AppInstance
retains data.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The data streaming configurations of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
" }, "PutRetentionSettings": { "name": "PutRetentionSettings", "http": { "method": "PUT", "requestUri": "/accounts/{accountId}/retention-settings", "responseCode": 204 }, "input": { "shape": "PutRetentionSettingsRequest" }, "output": { "shape": "PutRetentionSettingsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ConflictException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
" }, "PutSipMediaApplicationLoggingConfiguration": { "name": "PutSipMediaApplicationLoggingConfiguration", "http": { "method": "PUT", "requestUri": "/sip-media-applications/{sipMediaApplicationId}/logging-configuration", "responseCode": 200 }, "input": { "shape": "PutSipMediaApplicationLoggingConfigurationRequest" }, "output": { "shape": "PutSipMediaApplicationLoggingConfigurationResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates the logging configuration for the specified SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Adds origination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Adds termination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Redacts the specified message from the specified Amazon Chime conversation.
" }, "RedactRoomMessage": { "name": "RedactRoomMessage", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/rooms/{roomId}/messages/{messageId}?operation=redact", "responseCode": 200 }, "input": { "shape": "RedactRoomMessageRequest" }, "output": { "shape": "RedactRoomMessageResponse" }, "errors": [ { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "BadRequestException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Redacts the specified message from the specified Amazon Chime channel.
" }, "RegenerateSecurityToken": { "name": "RegenerateSecurityToken", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/bots/{botId}?operation=regenerate-security-token", "responseCode": 200 }, "input": { "shape": "RegenerateSecurityTokenRequest" }, "output": { "shape": "RegenerateSecurityTokenResponse" }, "errors": [ { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ThrottledClientException" } ], "documentation": "Regenerates the security token for a bot.
" }, "ResetPersonalPIN": { "name": "ResetPersonalPIN", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/users/{userId}?operation=reset-personal-pin", "responseCode": 200 }, "input": { "shape": "ResetPersonalPINRequest" }, "output": { "shape": "ResetPersonalPINResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
" }, "RestorePhoneNumber": { "name": "RestorePhoneNumber", "http": { "method": "POST", "requestUri": "/phone-numbers/{phoneNumberId}?operation=restore", "responseCode": 200 }, "input": { "shape": "RestorePhoneNumberRequest" }, "output": { "shape": "RestorePhoneNumberResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Moves a phone number from the Deletion queue back into the phone number Inventory.
" }, "SearchAvailablePhoneNumbers": { "name": "SearchAvailablePhoneNumbers", "http": { "method": "GET", "requestUri": "/search?type=phone-numbers" }, "input": { "shape": "SearchAvailablePhoneNumbersRequest" }, "output": { "shape": "SearchAvailablePhoneNumbersResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "AccessDeniedException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode
, City
, State
, or TollFreePrefix
. If you provide City
, you must also provide State
. Numbers outside the US only support the PhoneNumberType
filter, which you must use.
Sends a message to a particular channel that the member is a part of.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Starts transcription for the specified meetingId
. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.
If you specify an invalid configuration, a TranscriptFailed
event will be sent with the contents of the BadRequestException
generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.
This API is is no longer supported and will not be updated. We recommend using the latest version, StartMeetingTranscription, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Stops transcription for the specified meetingId
.
This API is is no longer supported and will not be updated. We recommend using the latest version, StopMeetingTranscription, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Applies the specified tags to the specified Amazon Chime attendee.
TagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
Applies the specified tags to the specified Amazon Chime SDK meeting.
This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Untags the specified tags from the specified Amazon Chime SDK attendee.
UntagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
Untags the specified tags from the specified Amazon Chime SDK meeting.
This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
" }, "UpdateAccountSettings": { "name": "UpdateAccountSettings", "http": { "method": "PUT", "requestUri": "/accounts/{accountId}/settings", "responseCode": 204 }, "input": { "shape": "UpdateAccountSettingsRequest" }, "output": { "shape": "UpdateAccountSettingsResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ConflictException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
" }, "UpdateAppInstance": { "name": "UpdateAppInstance", "http": { "method": "PUT", "requestUri": "/app-instances/{appInstanceArn}", "responseCode": 200 }, "input": { "shape": "UpdateAppInstanceRequest" }, "output": { "shape": "UpdateAppInstanceResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ConflictException" }, { "shape": "ForbiddenException" }, { "shape": "ThrottledClientException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates AppInstance
metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates the details of an AppInstanceUser
. You can update names and metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
" }, "UpdateChannel": { "name": "UpdateChannel", "http": { "method": "PUT", "requestUri": "/channels/{channelArn}", "responseCode": 200 }, "input": { "shape": "UpdateChannelRequest" }, "output": { "shape": "UpdateChannelResponse" }, "errors": [ { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ConflictException" }, { "shape": "UnauthorizedClientException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Update a channel's attributes.
Restriction: You can't change a channel's privacy.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates the content of a message.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The details of the time when a user last read messages in a channel.
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannelReadMarker, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
" }, "UpdatePhoneNumber": { "name": "UpdatePhoneNumber", "http": { "method": "POST", "requestUri": "/phone-numbers/{phoneNumberId}", "responseCode": 200 }, "input": { "shape": "UpdatePhoneNumberRequest" }, "output": { "shape": "UpdatePhoneNumberResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ConflictException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
" }, "UpdatePhoneNumberSettings": { "name": "UpdatePhoneNumberSettings", "http": { "method": "PUT", "requestUri": "/settings/phone-number", "responseCode": 204 }, "input": { "shape": "UpdatePhoneNumberSettingsRequest" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
" }, "UpdateProxySession": { "name": "UpdateProxySession", "http": { "method": "POST", "requestUri": "/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}", "responseCode": 201 }, "input": { "shape": "UpdateProxySessionRequest" }, "output": { "shape": "UpdateProxySessionResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates the specified proxy session details, such as voice or SMS capabilities.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
" }, "UpdateRoomMembership": { "name": "UpdateRoomMembership", "http": { "method": "POST", "requestUri": "/accounts/{accountId}/rooms/{roomId}/memberships/{memberId}", "responseCode": 200 }, "input": { "shape": "UpdateRoomMembershipRequest" }, "output": { "shape": "UpdateRoomMembershipResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "BadRequestException" }, { "shape": "ForbiddenException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
" }, "UpdateSipMediaApplication": { "name": "UpdateSipMediaApplication", "http": { "method": "PUT", "requestUri": "/sip-media-applications/{sipMediaApplicationId}", "responseCode": 200 }, "input": { "shape": "UpdateSipMediaApplicationRequest" }, "output": { "shape": "UpdateSipMediaApplicationResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ConflictException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates the details of the specified SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplicationCall, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates the details of the specified SIP rule.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for this action.
Updates the settings for the specified user, such as phone number settings.
" }, "UpdateVoiceConnector": { "name": "UpdateVoiceConnector", "http": { "method": "PUT", "requestUri": "/voice-connectors/{voiceConnectorId}", "responseCode": 200 }, "input": { "shape": "UpdateVoiceConnectorRequest" }, "output": { "shape": "UpdateVoiceConnectorResponse" }, "errors": [ { "shape": "UnauthorizedClientException" }, { "shape": "NotFoundException" }, { "shape": "ForbiddenException" }, { "shape": "BadRequestException" }, { "shape": "ThrottledClientException" }, { "shape": "ServiceUnavailableException" }, { "shape": "ServiceFailureException" } ], "documentation": "Updates details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.
This API is is no longer supported and will not be updated. We recommend using the latest version, ValidateE911Address, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The AWS account ID.
" }, "AccountId": { "shape": "String", "documentation": "The Amazon Chime account ID.
" }, "Name": { "shape": "String", "documentation": "The Amazon Chime account name.
" }, "AccountType": { "shape": "AccountType", "documentation": "The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The Amazon Chime account creation timestamp, in ISO 8601 format.
" }, "DefaultLicense": { "shape": "License", "documentation": "The default license for the Amazon Chime account.
" }, "SupportedLicenses": { "shape": "LicenseList", "documentation": "Supported licenses for the Amazon Chime account.
" }, "AccountStatus": { "shape": "AccountStatus", "documentation": "The status of the account.
" }, "SigninDelegateGroups": { "shape": "SigninDelegateGroupList", "documentation": "The sign-in delegate groups associated with the account.
" } }, "documentation": "The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
" }, "AccountList": { "type": "list", "member": { "shape": "Account" } }, "AccountName": { "type": "string", "max": 100, "min": 1, "pattern": ".*\\S.*" }, "AccountSettings": { "type": "structure", "members": { "DisableRemoteControl": { "shape": "Boolean", "documentation": "Setting that stops or starts remote control of shared screens during meetings.
" }, "EnableDialOut": { "shape": "Boolean", "documentation": "Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.
" } }, "documentation": "Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
" }, "AccountStatus": { "type": "string", "enum": [ "Suspended", "Active" ] }, "AccountType": { "type": "string", "enum": [ "Team", "EnterpriseDirectory", "EnterpriseLWA", "EnterpriseOIDC" ] }, "Address": { "type": "structure", "members": { "streetName": { "shape": "SensitiveNonEmptyString", "documentation": "The address street, such as 8th Avenue
.
The address suffix, such as the N
in 8th Avenue N
.
An address suffix location, such as the S. Unit A
in Central Park S. Unit A
.
An address prefix location, such as the N
in N. Third St.
.
The numeric portion of an address.
" }, "city": { "shape": "SensitiveNonEmptyString", "documentation": "The city of an address.
" }, "state": { "shape": "SensitiveNonEmptyString", "documentation": "The state of an address.
" }, "postalCode": { "shape": "SensitiveNonEmptyString", "documentation": "The postal code of an address.
" }, "postalCodePlus4": { "shape": "SensitiveNonEmptyString", "documentation": "The Zip + 4 or postal code + 4 of an address.
" }, "country": { "shape": "SensitiveNonEmptyString", "documentation": "The country of an address.
" } }, "documentation": "A validated address.
" }, "AlexaForBusinessMetadata": { "type": "structure", "members": { "IsAlexaForBusinessEnabled": { "shape": "Boolean", "documentation": "Starts or stops Alexa for Business.
" }, "AlexaForBusinessRoomArn": { "shape": "SensitiveString", "documentation": "The ARN of the room resource.
" } }, "documentation": "The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.
" }, "Alpha2CountryCode": { "type": "string", "pattern": "[A-Z]{2}" }, "AppInstance": { "type": "structure", "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the messaging instance.
" }, "Name": { "shape": "NonEmptyResourceName", "documentation": "The name of an AppInstance
.
The metadata of an AppInstance
.
The time at which an AppInstance
was created. In epoch milliseconds.
The time an AppInstance
was last updated. In epoch milliseconds.
The details of an AppInstance
, an instance of an Amazon Chime SDK messaging application.
The AppInstanceAdmin
data.
The ARN of the AppInstance
for which the user is an administrator.
The time at which an administrator was created.
" } }, "documentation": "The details of an AppInstanceAdmin
.
The details of the AppInstanceAdmin
.
Summary of the details of an AppInstanceAdmin
.
The length of time in days to retain the messages in a channel.
" } }, "documentation": "The details of the data-retention settings for an AppInstance
.
The type of data to be streamed.
" }, "ResourceArn": { "shape": "Arn", "documentation": "The resource ARN.
" } }, "documentation": "The details of the streaming configuration of an AppInstance
.
The AppInstance
ARN.
The name of the AppInstance
.
The metadata of the AppInstance
.
Summary of the data for an AppInstance
.
The ARN of the AppInstanceUser
.
The name of the AppInstanceUser
.
The time at which the AppInstanceUser
was created.
The metadata of the AppInstanceUser
.
The time at which the AppInstanceUser
was last updated.
The details of an AppInstanceUser
.
The type of ChannelMembership
.
The time at which a message was last read.
" } }, "documentation": "Summary of the membership details of an AppInstanceUser
.
The ARN of the AppInstanceUser
.
The name of an AppInstanceUser
.
The metadata of the AppInstanceUser
.
Summary of the details of an AppInstanceUser
.
The configuration for the audio artifacts.
" }, "Video": { "shape": "VideoArtifactsConfiguration", "documentation": "The configuration for the video artifacts.
" }, "Content": { "shape": "ContentArtifactsConfiguration", "documentation": "The configuration for the content artifacts.
" } }, "documentation": "The configuration for the artifacts.
" }, "ArtifactsState": { "type": "string", "enum": [ "Enabled", "Disabled" ] }, "AssociatePhoneNumberWithUserRequest": { "type": "structure", "required": [ "AccountId", "UserId", "E164PhoneNumber" ], "members": { "AccountId": { "shape": "String", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserId": { "shape": "String", "documentation": "The user ID.
", "location": "uri", "locationName": "userId" }, "E164PhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The phone number, in E.164 format.
" } } }, "AssociatePhoneNumberWithUserResponse": { "type": "structure", "members": {} }, "AssociatePhoneNumbersWithVoiceConnectorGroupRequest": { "type": "structure", "required": [ "VoiceConnectorGroupId", "E164PhoneNumbers" ], "members": { "VoiceConnectorGroupId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector group ID.
", "location": "uri", "locationName": "voiceConnectorGroupId" }, "E164PhoneNumbers": { "shape": "E164PhoneNumberList", "documentation": "List of phone numbers, in E.164 format.
" }, "ForceAssociate": { "shape": "NullableBoolean", "documentation": "If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
" } } }, "AssociatePhoneNumbersWithVoiceConnectorGroupResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "shape": "PhoneNumberErrorList", "documentation": "If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" } } }, "AssociatePhoneNumbersWithVoiceConnectorRequest": { "type": "structure", "required": [ "VoiceConnectorId", "E164PhoneNumbers" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "E164PhoneNumbers": { "shape": "E164PhoneNumberList", "documentation": "List of phone numbers, in E.164 format.
" }, "ForceAssociate": { "shape": "NullableBoolean", "documentation": "If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
" } } }, "AssociatePhoneNumbersWithVoiceConnectorResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "shape": "PhoneNumberErrorList", "documentation": "If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" } } }, "AssociateSigninDelegateGroupsWithAccountRequest": { "type": "structure", "required": [ "AccountId", "SigninDelegateGroups" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "SigninDelegateGroups": { "shape": "SigninDelegateGroupList", "documentation": "The sign-in delegate groups.
" } } }, "AssociateSigninDelegateGroupsWithAccountResponse": { "type": "structure", "members": {} }, "Attendee": { "type": "structure", "members": { "ExternalUserId": { "shape": "ExternalUserIdType", "documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" }, "AttendeeId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK attendee ID.
" }, "JoinToken": { "shape": "JoinTokenString", "documentation": "The join token used by the Amazon Chime SDK attendee.
" } }, "documentation": " An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId
and JoinToken
. The JoinToken
allows a client to authenticate and join as the specified attendee. The JoinToken
expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken
from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
The MUX type of the audio artifact configuration object.
" } }, "documentation": "The audio artifact configuration object.
" }, "AudioMuxType": { "type": "string", "enum": [ "AudioOnly", "AudioWithActiveSpeakerVideo" ] }, "BatchChannelMemberships": { "type": "structure", "members": { "InvitedBy": { "shape": "Identity", "documentation": "The identifier of the member who invited another member.
" }, "Type": { "shape": "ChannelMembershipType", "documentation": "The membership types set for the channel users.
" }, "Members": { "shape": "Members", "documentation": "The users successfully added to the request.
" }, "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel to which you're adding users.
" } }, "documentation": "The membership information, including member ARNs, the channel ARN, and membership types.
" }, "BatchCreateAttendeeErrorList": { "type": "list", "member": { "shape": "CreateAttendeeError" } }, "BatchCreateAttendeeRequest": { "type": "structure", "required": [ "MeetingId", "Attendees" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "Attendees": { "shape": "CreateAttendeeRequestItemList", "documentation": "The request containing the attendees to create.
" } } }, "BatchCreateAttendeeResponse": { "type": "structure", "members": { "Attendees": { "shape": "AttendeeList", "documentation": "The attendee information, including attendees IDs and join tokens.
" }, "Errors": { "shape": "BatchCreateAttendeeErrorList", "documentation": "If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
" } } }, "BatchCreateChannelMembershipError": { "type": "structure", "members": { "MemberArn": { "shape": "ChimeArn", "documentation": "The ARN of the member that the service couldn't add.
" }, "ErrorCode": { "shape": "ErrorCode", "documentation": "The error code.
" }, "ErrorMessage": { "shape": "String", "documentation": "The error message.
" } }, "documentation": "A list of failed member ARNs, error codes, and error messages.
" }, "BatchCreateChannelMembershipErrors": { "type": "list", "member": { "shape": "BatchCreateChannelMembershipError" } }, "BatchCreateChannelMembershipRequest": { "type": "structure", "required": [ "ChannelArn", "MemberArns" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel to which you're adding users.
", "location": "uri", "locationName": "channelArn" }, "Type": { "shape": "ChannelMembershipType", "documentation": "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.
The ARNs of the members you want to add to the channel.
" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The list of channel memberships in the response.
" }, "Errors": { "shape": "BatchCreateChannelMembershipErrors", "documentation": "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.
" } } }, "BatchCreateRoomMembershipRequest": { "type": "structure", "required": [ "AccountId", "RoomId", "MembershipItemList" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
", "location": "uri", "locationName": "roomId" }, "MembershipItemList": { "shape": "MembershipItemList", "documentation": "The list of membership items.
" } } }, "BatchCreateRoomMembershipResponse": { "type": "structure", "members": { "Errors": { "shape": "MemberErrorList", "documentation": "If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.
" } } }, "BatchDeletePhoneNumberRequest": { "type": "structure", "required": [ "PhoneNumberIds" ], "members": { "PhoneNumberIds": { "shape": "NonEmptyStringList", "documentation": "List of phone number IDs.
" } } }, "BatchDeletePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "shape": "PhoneNumberErrorList", "documentation": "If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" } } }, "BatchSuspendUserRequest": { "type": "structure", "required": [ "AccountId", "UserIdList" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserIdList": { "shape": "UserIdList", "documentation": "The request containing the user IDs to suspend.
" } } }, "BatchSuspendUserResponse": { "type": "structure", "members": { "UserErrors": { "shape": "UserErrorList", "documentation": "If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
" } } }, "BatchUnsuspendUserRequest": { "type": "structure", "required": [ "AccountId", "UserIdList" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserIdList": { "shape": "UserIdList", "documentation": "The request containing the user IDs to unsuspend.
" } } }, "BatchUnsuspendUserResponse": { "type": "structure", "members": { "UserErrors": { "shape": "UserErrorList", "documentation": "If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
" } } }, "BatchUpdatePhoneNumberRequest": { "type": "structure", "required": [ "UpdatePhoneNumberRequestItems" ], "members": { "UpdatePhoneNumberRequestItems": { "shape": "UpdatePhoneNumberRequestItemList", "documentation": "The request containing the phone number IDs and product types or calling names to update.
" } } }, "BatchUpdatePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "shape": "PhoneNumberErrorList", "documentation": "If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" } } }, "BatchUpdateUserRequest": { "type": "structure", "required": [ "AccountId", "UpdateUserRequestItems" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UpdateUserRequestItems": { "shape": "UpdateUserRequestItemList", "documentation": "The request containing the user IDs and details to update.
" } } }, "BatchUpdateUserResponse": { "type": "structure", "members": { "UserErrors": { "shape": "UserErrorList", "documentation": "If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
" } } }, "Boolean": { "type": "boolean" }, "Bot": { "type": "structure", "members": { "BotId": { "shape": "String", "documentation": "The bot ID.
" }, "UserId": { "shape": "String", "documentation": "The unique ID for the bot user.
" }, "DisplayName": { "shape": "SensitiveString", "documentation": "The bot display name.
" }, "BotType": { "shape": "BotType", "documentation": "The bot type.
" }, "Disabled": { "shape": "NullableBoolean", "documentation": "When true, the bot is stopped from running in your account.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The bot creation timestamp, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The updated bot timestamp, in ISO 8601 format.
" }, "BotEmail": { "shape": "SensitiveString", "documentation": "The bot email address.
" }, "SecurityToken": { "shape": "SensitiveString", "documentation": "The security token used to authenticate Amazon Chime with the outgoing event endpoint.
" } }, "documentation": "A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
" }, "BotList": { "type": "list", "member": { "shape": "Bot" } }, "BotType": { "type": "string", "enum": [ "ChatBot" ] }, "BusinessCallingSettings": { "type": "structure", "members": { "CdrBucket": { "shape": "String", "documentation": "The Amazon S3 bucket designated for call detail record storage.
", "box": true } }, "documentation": "The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.
" }, "CallingName": { "type": "string", "pattern": "^$|^[a-zA-Z0-9 ]{2,15}$", "sensitive": true }, "CallingNameStatus": { "type": "string", "enum": [ "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed" ] }, "CallingRegion": { "type": "string" }, "CallingRegionList": { "type": "list", "member": { "shape": "CallingRegion" } }, "CandidateAddress": { "type": "structure", "members": { "streetInfo": { "shape": "SensitiveNonEmptyString", "documentation": "The street information of a candidate address
" }, "streetNumber": { "shape": "SensitiveNonEmptyString", "documentation": "The numeric portion of a candidate address.
" }, "city": { "shape": "SensitiveNonEmptyString", "documentation": "The city of a candidate address.
" }, "state": { "shape": "SensitiveNonEmptyString", "documentation": "The state of a candidate address.
" }, "postalCode": { "shape": "SensitiveNonEmptyString", "documentation": "The postal code of a candidate address.
" }, "postalCodePlus4": { "shape": "SensitiveNonEmptyString", "documentation": "The Zip + 4 or postal code + 4 of a candidate address.
" }, "country": { "shape": "SensitiveNonEmptyString", "documentation": "The country of a candidate address.
" } }, "documentation": "A suggested address.
" }, "CandidateAddressList": { "type": "list", "member": { "shape": "CandidateAddress" } }, "Capability": { "type": "string", "enum": [ "Voice", "SMS" ] }, "CapabilityList": { "type": "list", "member": { "shape": "Capability" } }, "Channel": { "type": "structure", "members": { "Name": { "shape": "NonEmptyResourceName", "documentation": "The name of the channel.
" }, "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
" }, "Mode": { "shape": "ChannelMode", "documentation": "The mode of the channel.
" }, "Privacy": { "shape": "ChannelPrivacy", "documentation": "The channel's privacy setting.
" }, "Metadata": { "shape": "Metadata", "documentation": "The channel's metadata.
" }, "CreatedBy": { "shape": "Identity", "documentation": "The AppInstanceUser
who created the channel.
The time at which the AppInstanceUser
created the channel.
The time at which a member sent the last message in the channel.
" }, "LastUpdatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which a channel was last updated.
" } }, "documentation": "The details of a channel.
" }, "ChannelBan": { "type": "structure", "members": { "Member": { "shape": "Identity", "documentation": "The member being banned from the channel.
" }, "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel from which a member is being banned.
" }, "CreatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which the ban was created.
" }, "CreatedBy": { "shape": "Identity", "documentation": "The AppInstanceUser
who created the ban.
The details of a channel ban.
" }, "ChannelBanSummary": { "type": "structure", "members": { "Member": { "shape": "Identity", "documentation": "The member being banned from a channel.
" } }, "documentation": "Summary of the details of a ChannelBan
.
The identifier of the member who invited another member.
" }, "Type": { "shape": "ChannelMembershipType", "documentation": "The membership type set for the channel member.
" }, "Member": { "shape": "Identity", "documentation": "The data of the channel member.
" }, "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the member's channel.
" }, "CreatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which the channel membership was created.
" }, "LastUpdatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which a channel membership was last updated.
" } }, "documentation": "The details of a channel member.
" }, "ChannelMembershipForAppInstanceUserSummary": { "type": "structure", "members": { "ChannelSummary": { "shape": "ChannelSummary", "documentation": "Summary of the details of a Channel
.
Summary of the membership details of an AppInstanceUser
.
Summary of the channel membership details of an AppInstanceUser
.
A member's summary data.
" } }, "documentation": "Summary of the details of a ChannelMembership
.
The ARN of the channel.
" }, "MessageId": { "shape": "MessageId", "documentation": "The ID of a message.
" }, "Content": { "shape": "Content", "documentation": "The message content.
" }, "Metadata": { "shape": "Metadata", "documentation": "The message metadata.
" }, "Type": { "shape": "ChannelMessageType", "documentation": "The message type.
" }, "CreatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which the message was created.
" }, "LastEditedTimestamp": { "shape": "Timestamp", "documentation": "The time at which a message was edited.
" }, "LastUpdatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which a message was updated.
" }, "Sender": { "shape": "Identity", "documentation": "The message sender.
" }, "Redacted": { "shape": "NonNullableBoolean", "documentation": "Hides the content of a message.
" }, "Persistence": { "shape": "ChannelMessagePersistenceType", "documentation": "The persistence setting for a channel message.
" } }, "documentation": "The details of a message in a channel.
" }, "ChannelMessagePersistenceType": { "type": "string", "enum": [ "PERSISTENT", "NON_PERSISTENT" ] }, "ChannelMessageSummary": { "type": "structure", "members": { "MessageId": { "shape": "MessageId", "documentation": "The ID of the message.
" }, "Content": { "shape": "Content", "documentation": "The content of the message.
" }, "Metadata": { "shape": "Metadata", "documentation": "The metadata of the message.
" }, "Type": { "shape": "ChannelMessageType", "documentation": "The type of message.
" }, "CreatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which the message summary was created.
" }, "LastUpdatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which a message was last updated.
" }, "LastEditedTimestamp": { "shape": "Timestamp", "documentation": "The time at which a message was last edited.
" }, "Sender": { "shape": "Identity", "documentation": "The message sender.
" }, "Redacted": { "shape": "NonNullableBoolean", "documentation": "Indicates whether a message was redacted.
" } }, "documentation": "Summary of the messages in a Channel
.
Summary of the details of a Channel
.
Summary of the details of a moderated channel.
" }, "ChannelModeratedByAppInstanceUserSummaryList": { "type": "list", "member": { "shape": "ChannelModeratedByAppInstanceUserSummary" } }, "ChannelModerator": { "type": "structure", "members": { "Moderator": { "shape": "Identity", "documentation": "The moderator's data.
" }, "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the moderator's channel.
" }, "CreatedTimestamp": { "shape": "Timestamp", "documentation": "The time at which the moderator was created.
" }, "CreatedBy": { "shape": "Identity", "documentation": "The AppInstanceUser
who created the moderator.
The details of a channel moderator.
" }, "ChannelModeratorSummary": { "type": "structure", "members": { "Moderator": { "shape": "Identity", "documentation": "The data for a moderator.
" } }, "documentation": "Summary of the details of a ChannelModerator
.
The time in days to retain the messages in a channel.
" } }, "documentation": "The details of the retention settings for a channel.
" }, "ChannelSummary": { "type": "structure", "members": { "Name": { "shape": "NonEmptyResourceName", "documentation": "The name of the channel.
" }, "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
" }, "Mode": { "shape": "ChannelMode", "documentation": "The mode of the channel.
" }, "Privacy": { "shape": "ChannelPrivacy", "documentation": "The privacy setting of the channel.
" }, "Metadata": { "shape": "Metadata", "documentation": "The metadata of the channel.
" }, "LastMessageTimestamp": { "shape": "Timestamp", "documentation": "The time at which the last message in a channel was sent.
" } }, "documentation": "Summary of the details of a Channel
.
The source configuration for a specified media capture pipeline.
" }, "ArtifactsConfiguration": { "shape": "ArtifactsConfiguration", "documentation": "The configuration for the artifacts in an Amazon Chime SDK meeting.
" } }, "documentation": "The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType
must be ChimeSdkMeeting
.
Indicates whether the content artifact is enabled or disabled.
" }, "MuxType": { "shape": "ContentMuxType", "documentation": "The MUX type of the artifact configuration.
" } }, "documentation": "The content artifact object.
" }, "ContentMuxType": { "type": "string", "enum": [ "ContentOnly" ] }, "ConversationRetentionSettings": { "type": "structure", "members": { "RetentionDays": { "shape": "RetentionDays", "documentation": "The number of days for which to retain conversation messages.
" } }, "documentation": "The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account.
" }, "Country": { "type": "string", "pattern": "^$|^[A-Z]{2,2}$" }, "CountryList": { "type": "list", "member": { "shape": "Country" }, "max": 100, "min": 1 }, "CpsLimit": { "type": "integer", "min": 1 }, "CreateAccountRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "AccountName", "documentation": "The name of the Amazon Chime account.
" } } }, "CreateAccountResponse": { "type": "structure", "members": { "Account": { "shape": "Account", "documentation": "The Amazon Chime account details.
" } } }, "CreateAppInstanceAdminRequest": { "type": "structure", "required": [ "AppInstanceAdminArn", "AppInstanceArn" ], "members": { "AppInstanceAdminArn": { "shape": "ChimeArn", "documentation": "The ARN of the administrator of the current AppInstance
.
The ARN of the AppInstance
.
The name and ARN of the admin for the AppInstance
.
The ARN of the of the admin for the AppInstance
.
The name of the AppInstance
.
The metadata of the AppInstance
. Limited to a 1KB string in UTF-8.
The ClientRequestToken
of the AppInstance
.
Tags assigned to the AppInstance
.
The Amazon Resource Number (ARN) of the AppInstance
.
The ARN of the AppInstance
request.
The user ID of the AppInstance
.
The user's name.
" }, "Metadata": { "shape": "Metadata", "documentation": "The request's metadata. Limited to a 1KB string in UTF-8.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "The token assigned to the user requesting an AppInstance
.
Tags assigned to the AppInstanceUser
.
The user's ARN.
" } } }, "CreateAttendeeError": { "type": "structure", "members": { "ExternalUserId": { "shape": "ExternalUserIdType", "documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" }, "ErrorCode": { "shape": "String", "documentation": "The error code.
" }, "ErrorMessage": { "shape": "String", "documentation": "The error message.
" } }, "documentation": "The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.
" }, "CreateAttendeeRequest": { "type": "structure", "required": [ "MeetingId", "ExternalUserId" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "ExternalUserId": { "shape": "ExternalUserIdType", "documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" }, "Tags": { "shape": "AttendeeTagList", "documentation": "The tag key-value pairs.
" } } }, "CreateAttendeeRequestItem": { "type": "structure", "required": [ "ExternalUserId" ], "members": { "ExternalUserId": { "shape": "ExternalUserIdType", "documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" }, "Tags": { "shape": "AttendeeTagList", "documentation": "The tag key-value pairs.
" } }, "documentation": "The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
" }, "CreateAttendeeRequestItemList": { "type": "list", "member": { "shape": "CreateAttendeeRequestItem" } }, "CreateAttendeeResponse": { "type": "structure", "members": { "Attendee": { "shape": "Attendee", "documentation": "The attendee information, including attendee ID and join token.
" } } }, "CreateBotRequest": { "type": "structure", "required": [ "DisplayName", "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "DisplayName": { "shape": "SensitiveString", "documentation": "The bot display name.
" }, "Domain": { "shape": "NonEmptyString", "documentation": "The domain of the Amazon Chime Enterprise account.
" } } }, "CreateBotResponse": { "type": "structure", "members": { "Bot": { "shape": "Bot", "documentation": "The bot details.
" } } }, "CreateChannelBanRequest": { "type": "structure", "required": [ "ChannelArn", "MemberArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the ban request.
", "location": "uri", "locationName": "channelArn" }, "MemberArn": { "shape": "ChimeArn", "documentation": "The ARN of the member being banned.
" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the response to the ban request.
" }, "Member": { "shape": "Identity", "documentation": "The ChannelArn
and BannedIdentity
of the member in the ban response.
The ARN of the channel to which you're adding users.
", "location": "uri", "locationName": "channelArn" }, "MemberArn": { "shape": "ChimeArn", "documentation": "The ARN of the member you want to add to the channel.
" }, "Type": { "shape": "ChannelMembershipType", "documentation": "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.
The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" }, "Member": { "shape": "Identity", "documentation": "The ARN and metadata of the member being added.
" } } }, "CreateChannelModeratorRequest": { "type": "structure", "required": [ "ChannelArn", "ChannelModeratorArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "ChannelModeratorArn": { "shape": "ChimeArn", "documentation": "The ARN of the moderator.
" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" }, "ChannelModerator": { "shape": "Identity", "documentation": "The ARNs of the channel and the moderator.
" } } }, "CreateChannelRequest": { "type": "structure", "required": [ "AppInstanceArn", "Name", "ClientRequestToken" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel request.
" }, "Name": { "shape": "NonEmptyResourceName", "documentation": "The name of the channel.
" }, "Mode": { "shape": "ChannelMode", "documentation": "The channel mode: 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.
The channel's privacy level: PUBLIC
or PRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance
.
The metadata of the creation request. Limited to 1KB and UTF-8.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "The client token for the request. An Idempotency
token.
The tags for the creation request.
" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" } } }, "CreateMediaCapturePipelineRequest": { "type": "structure", "required": [ "SourceType", "SourceArn", "SinkType", "SinkArn" ], "members": { "SourceType": { "shape": "MediaPipelineSourceType", "documentation": "Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.
" }, "SourceArn": { "shape": "Arn", "documentation": "ARN of the source from which the media artifacts are captured.
" }, "SinkType": { "shape": "MediaPipelineSinkType", "documentation": "Destination type to which the media artifacts are saved. You must use an S3 bucket.
" }, "SinkArn": { "shape": "Arn", "documentation": "The ARN of the sink type.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "The unique identifier for the client request. The token makes the API request idempotent. Use a different token for different media pipeline requests.
", "idempotencyToken": true }, "ChimeSdkMeetingConfiguration": { "shape": "ChimeSdkMeetingConfiguration", "documentation": "The configuration for a specified media capture pipeline. SourceType
must be ChimeSdkMeeting
.
A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.
" } } }, "CreateMeetingDialOutRequest": { "type": "structure", "required": [ "MeetingId", "FromPhoneNumber", "ToPhoneNumber", "JoinToken" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "FromPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "Phone number used as the caller ID when the remote party receives a call.
" }, "ToPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "Phone number called when inviting someone to a meeting.
" }, "JoinToken": { "shape": "JoinTokenString", "documentation": "Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
" } } }, "CreateMeetingDialOutResponse": { "type": "structure", "members": { "TransactionId": { "shape": "GuidString", "documentation": "Unique ID that tracks API calls.
" } } }, "CreateMeetingRequest": { "type": "structure", "required": [ "ClientRequestToken" ], "members": { "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "The unique identifier for the client request. Use a different token for different meetings.
", "idempotencyToken": true }, "ExternalMeetingId": { "shape": "ExternalMeetingIdType", "documentation": "The external meeting ID.
" }, "MeetingHostId": { "shape": "ExternalUserIdType", "documentation": "Reserved.
" }, "MediaRegion": { "shape": "String", "documentation": " The Region in which to create the meeting. Default: us-east-1
.
Available values: af-south-1
, ap-northeast-1
, ap-northeast-2
, ap-south-1
, ap-southeast-1
, ap-southeast-2
, ca-central-1
, eu-central-1
, eu-north-1
, eu-south-1
, eu-west-1
, eu-west-2
, eu-west-3
, sa-east-1
, us-east-1
, us-east-2
, us-west-1
, us-west-2
.
The tag key-value pairs.
" }, "NotificationsConfiguration": { "shape": "MeetingNotificationConfiguration", "documentation": "The configuration for resource targets to receive notifications when meeting and attendee events occur.
" } } }, "CreateMeetingResponse": { "type": "structure", "members": { "Meeting": { "shape": "Meeting", "documentation": " The meeting information, including the meeting ID and MediaPlacement
.
The unique identifier for the client request. Use a different token for different meetings.
", "idempotencyToken": true }, "ExternalMeetingId": { "shape": "ExternalMeetingIdType", "documentation": "The external meeting ID.
" }, "MeetingHostId": { "shape": "ExternalUserIdType", "documentation": "Reserved.
" }, "MediaRegion": { "shape": "String", "documentation": " The Region in which to create the meeting. Default: us-east-1
.
Available values: af-south-1
, ap-northeast-1
, ap-northeast-2
, ap-south-1
, ap-southeast-1
, ap-southeast-2
, ca-central-1
, eu-central-1
, eu-north-1
, eu-south-1
, eu-west-1
, eu-west-2
, eu-west-3
, sa-east-1
, us-east-1
, us-east-2
, us-west-1
, us-west-2
.
The tag key-value pairs.
" }, "NotificationsConfiguration": { "shape": "MeetingNotificationConfiguration", "documentation": "The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).
" }, "Attendees": { "shape": "CreateMeetingWithAttendeesRequestItemList", "documentation": "The request containing the attendees to create.
" } } }, "CreateMeetingWithAttendeesRequestItemList": { "type": "list", "member": { "shape": "CreateAttendeeRequestItem" }, "max": 10, "min": 1 }, "CreateMeetingWithAttendeesResponse": { "type": "structure", "members": { "Meeting": { "shape": "Meeting", "documentation": "A meeting created using the Amazon Chime SDK.
" }, "Attendees": { "shape": "AttendeeList", "documentation": "The attendee information, including attendees IDs and join tokens.
" }, "Errors": { "shape": "BatchCreateAttendeeErrorList", "documentation": "If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
" } } }, "CreatePhoneNumberOrderRequest": { "type": "structure", "required": [ "ProductType", "E164PhoneNumbers" ], "members": { "ProductType": { "shape": "PhoneNumberProductType", "documentation": "The phone number product type.
" }, "E164PhoneNumbers": { "shape": "E164PhoneNumberList", "documentation": "List of phone numbers, in E.164 format.
" } } }, "CreatePhoneNumberOrderResponse": { "type": "structure", "members": { "PhoneNumberOrder": { "shape": "PhoneNumberOrder", "documentation": "The phone number order details.
" } } }, "CreateProxySessionRequest": { "type": "structure", "required": [ "ParticipantPhoneNumbers", "Capabilities", "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime voice connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "ParticipantPhoneNumbers": { "shape": "ParticipantPhoneNumberList", "documentation": "The participant phone numbers.
" }, "Name": { "shape": "ProxySessionNameString", "documentation": "The name of the proxy session.
" }, "ExpiryMinutes": { "shape": "PositiveInteger", "documentation": "The number of minutes allowed for the proxy session.
" }, "Capabilities": { "shape": "CapabilityList", "documentation": "The proxy session capabilities.
" }, "NumberSelectionBehavior": { "shape": "NumberSelectionBehavior", "documentation": "The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
" }, "GeoMatchLevel": { "shape": "GeoMatchLevel", "documentation": "The preference for matching the country or area code of the proxy phone number with that of the first participant.
" }, "GeoMatchParams": { "shape": "GeoMatchParams", "documentation": "The country and area code for the proxy phone number.
" } } }, "CreateProxySessionResponse": { "type": "structure", "members": { "ProxySession": { "shape": "ProxySession", "documentation": "The proxy session details.
" } } }, "CreateRoomMembershipRequest": { "type": "structure", "required": [ "AccountId", "RoomId", "MemberId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
", "location": "uri", "locationName": "roomId" }, "MemberId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime member ID (user ID or bot ID).
" }, "Role": { "shape": "RoomMembershipRole", "documentation": "The role of the member.
" } } }, "CreateRoomMembershipResponse": { "type": "structure", "members": { "RoomMembership": { "shape": "RoomMembership", "documentation": "The room membership details.
" } } }, "CreateRoomRequest": { "type": "structure", "required": [ "AccountId", "Name" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "Name": { "shape": "SensitiveString", "documentation": "The room name.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "The idempotency token for the request.
", "idempotencyToken": true } } }, "CreateRoomResponse": { "type": "structure", "members": { "Room": { "shape": "Room", "documentation": "The room details.
" } } }, "CreateSipMediaApplicationCallRequest": { "type": "structure", "required": [ "FromPhoneNumber", "ToPhoneNumber", "SipMediaApplicationId" ], "members": { "FromPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.
" }, "ToPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The phone number that the service should call.
" }, "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The ID of the SIP media application.
", "location": "uri", "locationName": "sipMediaApplicationId" }, "SipHeaders": { "shape": "SipHeadersMap", "documentation": "The SIP headers added to an outbound call leg.
" } } }, "CreateSipMediaApplicationCallResponse": { "type": "structure", "members": { "SipMediaApplicationCall": { "shape": "SipMediaApplicationCall", "documentation": "The actual call.
" } } }, "CreateSipMediaApplicationRequest": { "type": "structure", "required": [ "AwsRegion", "Name", "Endpoints" ], "members": { "AwsRegion": { "shape": "String", "documentation": "The AWS Region assigned to the SIP media application.
" }, "Name": { "shape": "SipMediaApplicationName", "documentation": "The SIP media application name.
" }, "Endpoints": { "shape": "SipMediaApplicationEndpointList", "documentation": "List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.
" } } }, "CreateSipMediaApplicationResponse": { "type": "structure", "members": { "SipMediaApplication": { "shape": "SipMediaApplication", "documentation": "The SIP media application details.
" } } }, "CreateSipRuleRequest": { "type": "structure", "required": [ "Name", "TriggerType", "TriggerValue", "TargetApplications" ], "members": { "Name": { "shape": "SipRuleName", "documentation": "The name of the SIP rule.
" }, "TriggerType": { "shape": "SipRuleTriggerType", "documentation": "The type of trigger assigned to the SIP rule in TriggerValue
, currently RequestUriHostname
or ToPhoneNumber
.
If TriggerType
is RequestUriHostname
, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType
is ToPhoneNumber
, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication
specified in the SipRule
is triggered if the request URI in an incoming SIP request matches the RequestUriHostname
, or if the To
header in the incoming SIP request matches the ToPhoneNumber
value.
Enables or disables a rule. You must disable rules before you can delete them.
" }, "TargetApplications": { "shape": "SipRuleTargetApplicationList", "documentation": "List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
" } } }, "CreateSipRuleResponse": { "type": "structure", "members": { "SipRule": { "shape": "SipRule", "documentation": "Returns the SIP rule information, including the rule ID, triggers, and target applications.
" } } }, "CreateUserRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "Username": { "shape": "String", "documentation": "The user name.
" }, "Email": { "shape": "EmailAddress", "documentation": "The user's email address.
" }, "UserType": { "shape": "UserType", "documentation": "The user type.
" } } }, "CreateUserResponse": { "type": "structure", "members": { "User": { "shape": "User", "documentation": "The user on the Amazon Chime account.
" } } }, "CreateVoiceConnectorGroupRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "VoiceConnectorGroupName", "documentation": "The name of the Amazon Chime Voice Connector group.
" }, "VoiceConnectorItems": { "shape": "VoiceConnectorItemList", "documentation": "The Amazon Chime Voice Connectors to route inbound calls to.
" } } }, "CreateVoiceConnectorGroupResponse": { "type": "structure", "members": { "VoiceConnectorGroup": { "shape": "VoiceConnectorGroup", "documentation": "The Amazon Chime Voice Connector group details.
" } } }, "CreateVoiceConnectorRequest": { "type": "structure", "required": [ "Name", "RequireEncryption" ], "members": { "Name": { "shape": "VoiceConnectorName", "documentation": "The name of the Amazon Chime Voice Connector.
" }, "AwsRegion": { "shape": "VoiceConnectorAwsRegion", "documentation": " The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
.
When enabled, requires encryption for the Amazon Chime Voice Connector.
" } } }, "CreateVoiceConnectorResponse": { "type": "structure", "members": { "VoiceConnector": { "shape": "VoiceConnector", "documentation": "The Amazon Chime Voice Connector details.
" } } }, "Credential": { "type": "structure", "members": { "Username": { "shape": "SensitiveString", "documentation": "The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.
" }, "Password": { "shape": "SensitiveString", "documentation": "The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
" } }, "documentation": "The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.
" }, "CredentialList": { "type": "list", "member": { "shape": "Credential" } }, "DNISEmergencyCallingConfiguration": { "type": "structure", "required": [ "EmergencyPhoneNumber", "CallingCountry" ], "members": { "EmergencyPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The DNIS phone number to route emergency calls to, in E.164 format.
" }, "TestPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The DNIS phone number to route test emergency calls to, in E.164 format.
" }, "CallingCountry": { "shape": "Alpha2CountryCode", "documentation": "The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
" } }, "documentation": "The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
" }, "DNISEmergencyCallingConfigurationList": { "type": "list", "member": { "shape": "DNISEmergencyCallingConfiguration" } }, "DataRetentionInHours": { "type": "integer", "min": 0 }, "DeleteAccountRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" } } }, "DeleteAccountResponse": { "type": "structure", "members": {} }, "DeleteAppInstanceAdminRequest": { "type": "structure", "required": [ "AppInstanceAdminArn", "AppInstanceArn" ], "members": { "AppInstanceAdminArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
's administrator.
The ARN of the AppInstance
.
The ARN of the AppInstance
.
The ARN of the streaming configurations being deleted.
", "location": "uri", "locationName": "appInstanceArn" } } }, "DeleteAppInstanceUserRequest": { "type": "structure", "required": [ "AppInstanceUserArn" ], "members": { "AppInstanceUserArn": { "shape": "ChimeArn", "documentation": "The ARN of the user request being deleted.
", "location": "uri", "locationName": "appInstanceUserArn" } } }, "DeleteAttendeeRequest": { "type": "structure", "required": [ "MeetingId", "AttendeeId" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "AttendeeId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK attendee ID.
", "location": "uri", "locationName": "attendeeId" } } }, "DeleteChannelBanRequest": { "type": "structure", "required": [ "ChannelArn", "MemberArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel from which the AppInstanceUser
was banned.
The ARN of the AppInstanceUser
that you want to reinstate.
The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel from which you want to remove the user.
", "location": "uri", "locationName": "channelArn" }, "MemberArn": { "shape": "ChimeArn", "documentation": "The ARN of the member that you're removing from the channel.
", "location": "uri", "locationName": "memberArn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "MessageId": { "shape": "MessageId", "documentation": "The ID of the message being deleted.
", "location": "uri", "locationName": "messageId" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "ChannelModeratorArn": { "shape": "ChimeArn", "documentation": "The ARN of the moderator being deleted.
", "location": "uri", "locationName": "channelModeratorArn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel being deleted.
", "location": "uri", "locationName": "channelArn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "BotId": { "shape": "NonEmptyString", "documentation": "The bot ID.
", "location": "uri", "locationName": "botId" } } }, "DeleteMediaCapturePipelineRequest": { "type": "structure", "required": [ "MediaPipelineId" ], "members": { "MediaPipelineId": { "shape": "GuidString", "documentation": "The ID of the media capture pipeline being deleted.
", "location": "uri", "locationName": "mediaPipelineId" } } }, "DeleteMeetingRequest": { "type": "structure", "required": [ "MeetingId" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" } } }, "DeletePhoneNumberRequest": { "type": "structure", "required": [ "PhoneNumberId" ], "members": { "PhoneNumberId": { "shape": "String", "documentation": "The phone number ID.
", "location": "uri", "locationName": "phoneNumberId" } } }, "DeleteProxySessionRequest": { "type": "structure", "required": [ "VoiceConnectorId", "ProxySessionId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime voice connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "ProxySessionId": { "shape": "NonEmptyString128", "documentation": "The proxy session ID.
", "location": "uri", "locationName": "proxySessionId" } } }, "DeleteRoomMembershipRequest": { "type": "structure", "required": [ "AccountId", "RoomId", "MemberId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
", "location": "uri", "locationName": "roomId" }, "MemberId": { "shape": "NonEmptyString", "documentation": "The member ID (user ID or bot ID).
", "location": "uri", "locationName": "memberId" } } }, "DeleteRoomRequest": { "type": "structure", "required": [ "AccountId", "RoomId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The chat room ID.
", "location": "uri", "locationName": "roomId" } } }, "DeleteSipMediaApplicationRequest": { "type": "structure", "required": [ "SipMediaApplicationId" ], "members": { "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The SIP media application ID.
", "location": "uri", "locationName": "sipMediaApplicationId" } } }, "DeleteSipRuleRequest": { "type": "structure", "required": [ "SipRuleId" ], "members": { "SipRuleId": { "shape": "NonEmptyString", "documentation": "The SIP rule ID.
", "location": "uri", "locationName": "sipRuleId" } } }, "DeleteVoiceConnectorEmergencyCallingConfigurationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "DeleteVoiceConnectorGroupRequest": { "type": "structure", "required": [ "VoiceConnectorGroupId" ], "members": { "VoiceConnectorGroupId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector group ID.
", "location": "uri", "locationName": "voiceConnectorGroupId" } } }, "DeleteVoiceConnectorOriginationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "DeleteVoiceConnectorProxyRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "DeleteVoiceConnectorRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "DeleteVoiceConnectorStreamingConfigurationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "DeleteVoiceConnectorTerminationCredentialsRequest": { "type": "structure", "required": [ "Usernames", "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "Usernames": { "shape": "SensitiveStringList", "documentation": "The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
" } } }, "DeleteVoiceConnectorTerminationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "DescribeAppInstanceAdminRequest": { "type": "structure", "required": [ "AppInstanceAdminArn", "AppInstanceArn" ], "members": { "AppInstanceAdminArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstanceAdmin
.
The ARN of the AppInstance
.
The ARN and name of the AppInstanceUser
, the ARN of the AppInstance
, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
The ARN of the AppInstance
.
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance
. All timestamps use epoch milliseconds.
The ARN of the AppInstanceUser
.
The name of the AppInstanceUser
.
The ARN of the channel from which the user is banned.
", "location": "uri", "locationName": "channelArn" }, "MemberArn": { "shape": "ChimeArn", "documentation": "The ARN of the member being banned.
", "location": "uri", "locationName": "memberArn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The details of the ban.
" } } }, "DescribeChannelMembershipForAppInstanceUserRequest": { "type": "structure", "required": [ "ChannelArn", "AppInstanceUserArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel to which the user belongs.
", "location": "uri", "locationName": "channelArn" }, "AppInstanceUserArn": { "shape": "ChimeArn", "documentation": "The ARN of the user in a channel.
", "location": "querystring", "locationName": "app-instance-user-arn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The channel to which a user belongs.
" } } }, "DescribeChannelMembershipRequest": { "type": "structure", "required": [ "ChannelArn", "MemberArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "MemberArn": { "shape": "ChimeArn", "documentation": "The ARN of the member.
", "location": "uri", "locationName": "memberArn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The details of the membership.
" } } }, "DescribeChannelModeratedByAppInstanceUserRequest": { "type": "structure", "required": [ "ChannelArn", "AppInstanceUserArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the moderated channel.
", "location": "uri", "locationName": "channelArn" }, "AppInstanceUserArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstanceUser
in the moderated channel.
The AppInstanceUserArn
of the user that makes the API call.
The moderated channel.
" } } }, "DescribeChannelModeratorRequest": { "type": "structure", "required": [ "ChannelArn", "ChannelModeratorArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "ChannelModeratorArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel moderator.
", "location": "uri", "locationName": "channelModeratorArn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The details of the channel moderator.
" } } }, "DescribeChannelRequest": { "type": "structure", "required": [ "ChannelArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The channel details.
" } } }, "DisassociatePhoneNumberFromUserRequest": { "type": "structure", "required": [ "AccountId", "UserId" ], "members": { "AccountId": { "shape": "String", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserId": { "shape": "String", "documentation": "The user ID.
", "location": "uri", "locationName": "userId" } } }, "DisassociatePhoneNumberFromUserResponse": { "type": "structure", "members": {} }, "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest": { "type": "structure", "required": [ "VoiceConnectorGroupId", "E164PhoneNumbers" ], "members": { "VoiceConnectorGroupId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector group ID.
", "location": "uri", "locationName": "voiceConnectorGroupId" }, "E164PhoneNumbers": { "shape": "E164PhoneNumberList", "documentation": "List of phone numbers, in E.164 format.
" } } }, "DisassociatePhoneNumbersFromVoiceConnectorGroupResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "shape": "PhoneNumberErrorList", "documentation": "If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" } } }, "DisassociatePhoneNumbersFromVoiceConnectorRequest": { "type": "structure", "required": [ "VoiceConnectorId", "E164PhoneNumbers" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "E164PhoneNumbers": { "shape": "E164PhoneNumberList", "documentation": "List of phone numbers, in E.164 format.
" } } }, "DisassociatePhoneNumbersFromVoiceConnectorResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "shape": "PhoneNumberErrorList", "documentation": "If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" } } }, "DisassociateSigninDelegateGroupsFromAccountRequest": { "type": "structure", "required": [ "AccountId", "GroupNames" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "GroupNames": { "shape": "NonEmptyStringList", "documentation": "The sign-in delegate group names.
" } } }, "DisassociateSigninDelegateGroupsFromAccountResponse": { "type": "structure", "members": {} }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+?[1-9]\\d{1,14}$", "sensitive": true }, "E164PhoneNumberList": { "type": "list", "member": { "shape": "E164PhoneNumber" } }, "EmailAddress": { "type": "string", "pattern": ".+@.+\\..+", "sensitive": true }, "EmailStatus": { "type": "string", "enum": [ "NotSent", "Sent", "Failed" ] }, "EmergencyCallingConfiguration": { "type": "structure", "members": { "DNIS": { "shape": "DNISEmergencyCallingConfigurationList", "documentation": "The Dialed Number Identification Service (DNIS) emergency calling configuration details.
" } }, "documentation": "The emergency calling configuration details associated with an Amazon Chime Voice Connector.
" }, "EngineTranscribeMedicalSettings": { "type": "structure", "required": [ "LanguageCode", "Specialty", "Type" ], "members": { "LanguageCode": { "shape": "TranscribeMedicalLanguageCode", "documentation": "The language code specified for the Amazon Transcribe Medical engine.
" }, "Specialty": { "shape": "TranscribeMedicalSpecialty", "documentation": "The specialty specified for the Amazon Transcribe Medical engine.
" }, "Type": { "shape": "TranscribeMedicalType", "documentation": "The type of transcription.
" }, "VocabularyName": { "shape": "String", "documentation": "The name of the vocabulary passed to Amazon Transcribe Medical.
" }, "Region": { "shape": "TranscribeMedicalRegion", "documentation": "The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" }, "ContentIdentificationType": { "shape": "TranscribeMedicalContentIdentificationType", "documentation": "Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes
, all PII is identified.
You can’t set ContentIdentificationType
and ContentRedactionType
.
Settings specific to the Amazon Transcribe Medical engine.
" }, "EngineTranscribeSettings": { "type": "structure", "members": { "LanguageCode": { "shape": "TranscribeLanguageCode", "documentation": "Specify the language code that represents the language spoken.
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage
to enable automatic language identification.
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***
, choose mask
.
To delete words, choose remove
.
To flag words without changing them, choose tag
.
Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
If you include IdentifyLanguage
and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames
parameter instead.
Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
If you include IdentifyLanguage
and want to use one or more custom vocabularies with your transcription, use the VocabularyNames
parameter instead.
The AWS Region in which to use Amazon Transcribe.
If you don't specify a Region, then the MediaRegion
parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in the MediaRegion
, then a TranscriptFailed event is sent.
Use auto
to use Amazon Transcribe in a Region near the meeting’s MediaRegion
. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
" }, "PartialResultsStability": { "shape": "TranscribePartialResultsStability", "documentation": "Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization
).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
" }, "ContentIdentificationType": { "shape": "TranscribeContentIdentificationType", "documentation": "Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes
, all PII is identified.
You can’t set ContentIdentificationType
and ContentRedactionType
.
Content redaction is performed at the segment level. If you don't include PiiEntityTypes
, all PII is redacted.
You can’t set ContentIdentificationType
and ContentRedactionType
.
Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL
.
Values must be comma-separated and can include: ADDRESS
, BANK_ACCOUNT_NUMBER
, BANK_ROUTING
, CREDIT_DEBIT_CVV
, CREDIT_DEBIT_EXPIRY
CREDIT_DEBIT_NUMBER
, EMAIL
,NAME
, PHONE
, PIN
, SSN
, or ALL
.
Note that if you include PiiEntityTypes
, you must also include ContentIdentificationType
or ContentRedactionType
.
If you include ContentRedactionType
or ContentIdentificationType
, but do not include PiiEntityTypes
, all PII is redacted or identified.
Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.
The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.
" }, "IdentifyLanguage": { "shape": "Boolean", "documentation": "Enables automatic language identification for your transcription.
If you include IdentifyLanguage
, you can optionally use LanguageOptions
to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.
You can also use PreferredLanguage
to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.
You must include either LanguageCode
or IdentifyLanguage
.
Language identification can't be combined with custom language models or redaction.
" }, "LanguageOptions": { "shape": "TranscribeLanguageOptions", "documentation": "Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
Including language options can improve the accuracy of language identification.
If you include LanguageOptions
, you must also include IdentifyLanguage
.
You can only include one language dialect per language. For example, you cannot include en-US
and en-AU
.
Specify a preferred language from the subset of languages codes you specified in LanguageOptions
.
You can only use this parameter if you include IdentifyLanguage
and LanguageOptions
.
Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
If you don't include IdentifyLanguage
and want to use a custom vocabulary with your transcription, use the VocabularyName
parameter instead.
Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
If you're not including IdentifyLanguage
and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName
parameter instead.
Settings specific for Amazon Transcribe as the live transcription engine.
If you specify an invalid combination of parameters, a TranscriptFailed
event will be sent with the contents of the BadRequestException
generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
The bot ID.
" }, "OutboundEventsHTTPSEndpoint": { "shape": "SensitiveString", "documentation": "HTTPS endpoint that allows a bot to receive outgoing events.
" }, "LambdaFunctionArn": { "shape": "SensitiveString", "documentation": "Lambda function ARN that allows a bot to receive outgoing events.
" } }, "documentation": "The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
" }, "ExternalMeetingIdType": { "type": "string", "max": 64, "min": 2, "sensitive": true }, "ExternalUserIdList": { "type": "list", "member": { "shape": "ExternalUserIdType" }, "min": 1 }, "ExternalUserIdType": { "type": "string", "max": 64, "min": 2, "sensitive": true }, "FunctionArn": { "type": "string", "max": 10000, "pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?", "sensitive": true }, "GeoMatchLevel": { "type": "string", "enum": [ "Country", "AreaCode" ] }, "GeoMatchParams": { "type": "structure", "required": [ "Country", "AreaCode" ], "members": { "Country": { "shape": "Country", "documentation": "The country.
" }, "AreaCode": { "shape": "AreaCode", "documentation": "The area code.
" } }, "documentation": "The country and area code for a proxy phone number in a proxy phone session.
" }, "GetAccountRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" } } }, "GetAccountResponse": { "type": "structure", "members": { "Account": { "shape": "Account", "documentation": "The Amazon Chime account details.
" } } }, "GetAccountSettingsRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" } } }, "GetAccountSettingsResponse": { "type": "structure", "members": { "AccountSettings": { "shape": "AccountSettings", "documentation": "The Amazon Chime account settings.
" } } }, "GetAppInstanceRetentionSettingsRequest": { "type": "structure", "required": [ "AppInstanceArn" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The retention settings for the AppInstance
.
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
" } } }, "GetAppInstanceStreamingConfigurationsRequest": { "type": "structure", "required": [ "AppInstanceArn" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The streaming settings.
" } } }, "GetAttendeeRequest": { "type": "structure", "required": [ "MeetingId", "AttendeeId" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "AttendeeId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK attendee ID.
", "location": "uri", "locationName": "attendeeId" } } }, "GetAttendeeResponse": { "type": "structure", "members": { "Attendee": { "shape": "Attendee", "documentation": "The Amazon Chime SDK attendee information.
" } } }, "GetBotRequest": { "type": "structure", "required": [ "AccountId", "BotId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "BotId": { "shape": "NonEmptyString", "documentation": "The bot ID.
", "location": "uri", "locationName": "botId" } } }, "GetBotResponse": { "type": "structure", "members": { "Bot": { "shape": "Bot", "documentation": "The chat bot details.
" } } }, "GetChannelMessageRequest": { "type": "structure", "required": [ "ChannelArn", "MessageId" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "MessageId": { "shape": "MessageId", "documentation": "The ID of the message.
", "location": "uri", "locationName": "messageId" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The details of and content in the message.
" } } }, "GetEventsConfigurationRequest": { "type": "structure", "required": [ "AccountId", "BotId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "BotId": { "shape": "NonEmptyString", "documentation": "The bot ID.
", "location": "uri", "locationName": "botId" } } }, "GetEventsConfigurationResponse": { "type": "structure", "members": { "EventsConfiguration": { "shape": "EventsConfiguration", "documentation": "The events configuration details.
" } } }, "GetGlobalSettingsResponse": { "type": "structure", "members": { "BusinessCalling": { "shape": "BusinessCallingSettings", "documentation": "The Amazon Chime Business Calling settings.
" }, "VoiceConnector": { "shape": "VoiceConnectorSettings", "documentation": "The Amazon Chime Voice Connector settings.
" } } }, "GetMediaCapturePipelineRequest": { "type": "structure", "required": [ "MediaPipelineId" ], "members": { "MediaPipelineId": { "shape": "GuidString", "documentation": "The ID of the pipeline that you want to get.
", "location": "uri", "locationName": "mediaPipelineId" } } }, "GetMediaCapturePipelineResponse": { "type": "structure", "members": { "MediaCapturePipeline": { "shape": "MediaCapturePipeline", "documentation": "The media capture pipeline object.
" } } }, "GetMeetingRequest": { "type": "structure", "required": [ "MeetingId" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" } } }, "GetMeetingResponse": { "type": "structure", "members": { "Meeting": { "shape": "Meeting", "documentation": "The Amazon Chime SDK meeting information.
" } } }, "GetMessagingSessionEndpointRequest": { "type": "structure", "members": {} }, "GetMessagingSessionEndpointResponse": { "type": "structure", "members": { "Endpoint": { "shape": "MessagingSessionEndpoint", "documentation": "The endpoint returned in the response.
" } } }, "GetPhoneNumberOrderRequest": { "type": "structure", "required": [ "PhoneNumberOrderId" ], "members": { "PhoneNumberOrderId": { "shape": "GuidString", "documentation": "The ID for the phone number order.
", "location": "uri", "locationName": "phoneNumberOrderId" } } }, "GetPhoneNumberOrderResponse": { "type": "structure", "members": { "PhoneNumberOrder": { "shape": "PhoneNumberOrder", "documentation": "The phone number order details.
" } } }, "GetPhoneNumberRequest": { "type": "structure", "required": [ "PhoneNumberId" ], "members": { "PhoneNumberId": { "shape": "String", "documentation": "The phone number ID.
", "location": "uri", "locationName": "phoneNumberId" } } }, "GetPhoneNumberResponse": { "type": "structure", "members": { "PhoneNumber": { "shape": "PhoneNumber", "documentation": "The phone number details.
" } } }, "GetPhoneNumberSettingsResponse": { "type": "structure", "members": { "CallingName": { "shape": "CallingName", "documentation": "The default outbound calling name for the account.
" }, "CallingNameUpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The updated outbound calling name timestamp, in ISO 8601 format.
" } } }, "GetProxySessionRequest": { "type": "structure", "required": [ "VoiceConnectorId", "ProxySessionId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime voice connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "ProxySessionId": { "shape": "NonEmptyString128", "documentation": "The proxy session ID.
", "location": "uri", "locationName": "proxySessionId" } } }, "GetProxySessionResponse": { "type": "structure", "members": { "ProxySession": { "shape": "ProxySession", "documentation": "The proxy session details.
" } } }, "GetRetentionSettingsRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" } } }, "GetRetentionSettingsResponse": { "type": "structure", "members": { "RetentionSettings": { "shape": "RetentionSettings", "documentation": "The retention settings.
" }, "InitiateDeletionTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
" } } }, "GetRoomRequest": { "type": "structure", "required": [ "AccountId", "RoomId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
", "location": "uri", "locationName": "roomId" } } }, "GetRoomResponse": { "type": "structure", "members": { "Room": { "shape": "Room", "documentation": "The room details.
" } } }, "GetSipMediaApplicationLoggingConfigurationRequest": { "type": "structure", "required": [ "SipMediaApplicationId" ], "members": { "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The SIP media application ID.
", "location": "uri", "locationName": "sipMediaApplicationId" } } }, "GetSipMediaApplicationLoggingConfigurationResponse": { "type": "structure", "members": { "SipMediaApplicationLoggingConfiguration": { "shape": "SipMediaApplicationLoggingConfiguration", "documentation": "The actual logging configuration.
" } } }, "GetSipMediaApplicationRequest": { "type": "structure", "required": [ "SipMediaApplicationId" ], "members": { "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The SIP media application ID.
", "location": "uri", "locationName": "sipMediaApplicationId" } } }, "GetSipMediaApplicationResponse": { "type": "structure", "members": { "SipMediaApplication": { "shape": "SipMediaApplication", "documentation": "The SIP media application details.
" } } }, "GetSipRuleRequest": { "type": "structure", "required": [ "SipRuleId" ], "members": { "SipRuleId": { "shape": "NonEmptyString", "documentation": "The SIP rule ID.
", "location": "uri", "locationName": "sipRuleId" } } }, "GetSipRuleResponse": { "type": "structure", "members": { "SipRule": { "shape": "SipRule", "documentation": "The SIP rule details.
" } } }, "GetUserRequest": { "type": "structure", "required": [ "AccountId", "UserId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserId": { "shape": "NonEmptyString", "documentation": "The user ID.
", "location": "uri", "locationName": "userId" } } }, "GetUserResponse": { "type": "structure", "members": { "User": { "shape": "User", "documentation": "The user details.
" } } }, "GetUserSettingsRequest": { "type": "structure", "required": [ "AccountId", "UserId" ], "members": { "AccountId": { "shape": "String", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserId": { "shape": "String", "documentation": "The user ID.
", "location": "uri", "locationName": "userId" } } }, "GetUserSettingsResponse": { "type": "structure", "members": { "UserSettings": { "shape": "UserSettings", "documentation": "The user settings.
" } } }, "GetVoiceConnectorEmergencyCallingConfigurationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "GetVoiceConnectorEmergencyCallingConfigurationResponse": { "type": "structure", "members": { "EmergencyCallingConfiguration": { "shape": "EmergencyCallingConfiguration", "documentation": "The emergency calling configuration details.
" } } }, "GetVoiceConnectorGroupRequest": { "type": "structure", "required": [ "VoiceConnectorGroupId" ], "members": { "VoiceConnectorGroupId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector group ID.
", "location": "uri", "locationName": "voiceConnectorGroupId" } } }, "GetVoiceConnectorGroupResponse": { "type": "structure", "members": { "VoiceConnectorGroup": { "shape": "VoiceConnectorGroup", "documentation": "The Amazon Chime Voice Connector group details.
" } } }, "GetVoiceConnectorLoggingConfigurationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "GetVoiceConnectorLoggingConfigurationResponse": { "type": "structure", "members": { "LoggingConfiguration": { "shape": "LoggingConfiguration", "documentation": "The logging configuration details.
" } } }, "GetVoiceConnectorOriginationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "GetVoiceConnectorOriginationResponse": { "type": "structure", "members": { "Origination": { "shape": "Origination", "documentation": "The origination setting details.
" } } }, "GetVoiceConnectorProxyRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime voice connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "GetVoiceConnectorProxyResponse": { "type": "structure", "members": { "Proxy": { "shape": "Proxy", "documentation": "The proxy configuration details.
" } } }, "GetVoiceConnectorRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "GetVoiceConnectorResponse": { "type": "structure", "members": { "VoiceConnector": { "shape": "VoiceConnector", "documentation": "The Amazon Chime Voice Connector details.
" } } }, "GetVoiceConnectorStreamingConfigurationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "GetVoiceConnectorStreamingConfigurationResponse": { "type": "structure", "members": { "StreamingConfiguration": { "shape": "StreamingConfiguration", "documentation": "The streaming configuration details.
" } } }, "GetVoiceConnectorTerminationHealthRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "GetVoiceConnectorTerminationHealthResponse": { "type": "structure", "members": { "TerminationHealth": { "shape": "TerminationHealth", "documentation": "The termination health details.
" } } }, "GetVoiceConnectorTerminationRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "GetVoiceConnectorTerminationResponse": { "type": "structure", "members": { "Termination": { "shape": "Termination", "documentation": "The termination setting details.
" } } }, "GuidString": { "type": "string", "pattern": "[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" }, "Identity": { "type": "structure", "members": { "Arn": { "shape": "ChimeArn", "documentation": "The ARN in an Identity.
" }, "Name": { "shape": "ResourceName", "documentation": "The name in an Identity.
" } }, "documentation": "The details of a user.
" }, "Integer": { "type": "integer" }, "Invite": { "type": "structure", "members": { "InviteId": { "shape": "String", "documentation": "The invite ID.
" }, "Status": { "shape": "InviteStatus", "documentation": "The status of the invite.
" }, "EmailAddress": { "shape": "EmailAddress", "documentation": "The email address to which the invite is sent.
" }, "EmailStatus": { "shape": "EmailStatus", "documentation": "The status of the invite email.
" } }, "documentation": "Invitation object returned after emailing users to invite them to join the Amazon Chime Team
account.
The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserEmailList": { "shape": "UserEmailList", "documentation": "The user email addresses to which to send the email invitation.
" }, "UserType": { "shape": "UserType", "documentation": "The user type.
" } } }, "InviteUsersResponse": { "type": "structure", "members": { "Invites": { "shape": "InviteList", "documentation": "The email invitation details.
" } } }, "Iso8601Timestamp": { "type": "timestamp", "timestampFormat": "iso8601" }, "JoinTokenString": { "type": "string", "max": 2048, "min": 2, "pattern": "^[a-zA-Z0-9+/]+$", "sensitive": true }, "License": { "type": "string", "enum": [ "Basic", "Plus", "Pro", "ProTrial" ] }, "LicenseList": { "type": "list", "member": { "shape": "License" } }, "ListAccountsRequest": { "type": "structure", "members": { "Name": { "shape": "AccountName", "documentation": "Amazon Chime account name prefix with which to filter results.
", "location": "querystring", "locationName": "name" }, "UserEmail": { "shape": "EmailAddress", "documentation": "User email address with which to filter results.
", "location": "querystring", "locationName": "user-email" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" }, "MaxResults": { "shape": "ProfileServiceMaxResults", "documentation": "The maximum number of results to return in a single call. Defaults to 100.
", "location": "querystring", "locationName": "max-results" } } }, "ListAccountsResponse": { "type": "structure", "members": { "Accounts": { "shape": "AccountList", "documentation": "List of Amazon Chime accounts and account details.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListAppInstanceAdminsRequest": { "type": "structure", "required": [ "AppInstanceArn" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The maximum number of administrators that you want to return.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from previous API requests until the number of administrators is reached.
", "location": "querystring", "locationName": "next-token" } } }, "ListAppInstanceAdminsResponse": { "type": "structure", "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The information for each administrator.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from previous API requests until the number of administrators is reached.
" } } }, "ListAppInstanceUsersRequest": { "type": "structure", "required": [ "AppInstanceArn" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The maximum number of requests that you want returned.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested users are returned.
", "location": "querystring", "locationName": "next-token" } } }, "ListAppInstanceUsersResponse": { "type": "structure", "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The information for each requested AppInstanceUser
.
The token passed by previous API calls until all requested users are returned.
" } } }, "ListAppInstancesRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "documentation": "The maximum number of AppInstance
s that you want to return.
The token passed by previous API requests until you reach the maximum number of AppInstance
s.
The information for each AppInstance
.
The token passed by previous API requests until the maximum number of AppInstance
s is reached.
The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "AttendeeId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK attendee ID.
", "location": "uri", "locationName": "attendeeId" } } }, "ListAttendeeTagsResponse": { "type": "structure", "members": { "Tags": { "shape": "TagList", "documentation": "A list of tag key-value pairs.
" } } }, "ListAttendeesRequest": { "type": "structure", "required": [ "MeetingId" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" } } }, "ListAttendeesResponse": { "type": "structure", "members": { "Attendees": { "shape": "AttendeeList", "documentation": "The Amazon Chime SDK attendee information.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListBotsRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call. The default is 10.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" } } }, "ListBotsResponse": { "type": "structure", "members": { "Bots": { "shape": "BotList", "documentation": "List of bots and bot details.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListChannelBansRequest": { "type": "structure", "required": [ "ChannelArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "MaxResults": { "shape": "MaxResults", "documentation": "The maximum number of bans that you want returned.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested bans are returned.
", "location": "querystring", "locationName": "next-token" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested bans are returned.
" }, "ChannelBans": { "shape": "ChannelBanSummaryList", "documentation": "The information for each requested ban.
" } } }, "ListChannelMembershipsForAppInstanceUserRequest": { "type": "structure", "members": { "AppInstanceUserArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstanceUser
s
The maximum number of users that you want returned.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from previous API requests until the number of channel memberships is reached.
", "location": "querystring", "locationName": "next-token" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The information for the requested channel memberships.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested users are returned.
" } } }, "ListChannelMembershipsRequest": { "type": "structure", "required": [ "ChannelArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The maximum number of channel memberships that you want returned.
", "location": "uri", "locationName": "channelArn" }, "Type": { "shape": "ChannelMembershipType", "documentation": "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.
The maximum number of channel memberships that you want returned.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested channel memberships are returned.
", "location": "querystring", "locationName": "next-token" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" }, "ChannelMemberships": { "shape": "ChannelMembershipSummaryList", "documentation": "The information for the requested channel memberships.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested channel memberships are returned.
" } } }, "ListChannelMessagesRequest": { "type": "structure", "required": [ "ChannelArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "SortOrder": { "shape": "SortOrder", "documentation": "The order in which you want messages sorted. Default is Descending, based on time created.
", "location": "querystring", "locationName": "sort-order" }, "NotBefore": { "shape": "Timestamp", "documentation": "The initial or starting time stamp for your requested messages.
", "location": "querystring", "locationName": "not-before" }, "NotAfter": { "shape": "Timestamp", "documentation": "The final or ending time stamp for your requested messages.
", "location": "querystring", "locationName": "not-after" }, "MaxResults": { "shape": "MaxResults", "documentation": "The maximum number of messages that you want returned.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested messages are returned.
", "location": "querystring", "locationName": "next-token" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel containing the requested messages.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested messages are returned.
" }, "ChannelMessages": { "shape": "ChannelMessageSummaryList", "documentation": "The information about, and content of, each requested message.
" } } }, "ListChannelModeratorsRequest": { "type": "structure", "required": [ "ChannelArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "MaxResults": { "shape": "MaxResults", "documentation": "The maximum number of moderators that you want returned.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested moderators are returned.
", "location": "querystring", "locationName": "next-token" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested moderators are returned.
" }, "ChannelModerators": { "shape": "ChannelModeratorSummaryList", "documentation": "The information about and names of each moderator.
" } } }, "ListChannelsModeratedByAppInstanceUserRequest": { "type": "structure", "members": { "AppInstanceUserArn": { "shape": "ChimeArn", "documentation": "The ARN of the user in the moderated channel.
", "location": "querystring", "locationName": "app-instance-user-arn" }, "MaxResults": { "shape": "MaxResults", "documentation": "The maximum number of channels in the request.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from previous API requests until the number of channels moderated by the user is reached.
", "location": "querystring", "locationName": "next-token" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The moderated channels in the request.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from previous API requests until the number of channels moderated by the user is reached.
" } } }, "ListChannelsRequest": { "type": "structure", "required": [ "AppInstanceArn" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The privacy setting. PUBLIC
retrieves all the public channels. PRIVATE
retrieves private channels. Only an AppInstanceAdmin
can retrieve private channels.
The maximum number of channels that you want to return.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextToken", "documentation": "The token passed by previous API calls until all requested channels are returned.
", "location": "querystring", "locationName": "next-token" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The information about each channel.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from previous API requests until the number of channels is reached.
" } } }, "ListMediaCapturePipelinesRequest": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token used to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call. Valid Range: 1 - 99.
", "location": "querystring", "locationName": "max-results" } } }, "ListMediaCapturePipelinesResponse": { "type": "structure", "members": { "MediaCapturePipelines": { "shape": "MediaCapturePipelineList", "documentation": "The media capture pipeline objects in the list.
" }, "NextToken": { "shape": "String", "documentation": "The token used to retrieve the next page of results.
" } } }, "ListMeetingTagsRequest": { "type": "structure", "required": [ "MeetingId" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" } } }, "ListMeetingTagsResponse": { "type": "structure", "members": { "Tags": { "shape": "TagList", "documentation": "A list of tag key-value pairs.
" } } }, "ListMeetingsRequest": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" } } }, "ListMeetingsResponse": { "type": "structure", "members": { "Meetings": { "shape": "MeetingList", "documentation": "The Amazon Chime SDK meeting information.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListPhoneNumberOrdersRequest": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" } } }, "ListPhoneNumberOrdersResponse": { "type": "structure", "members": { "PhoneNumberOrders": { "shape": "PhoneNumberOrderList", "documentation": "The phone number order details.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListPhoneNumbersRequest": { "type": "structure", "members": { "Status": { "shape": "PhoneNumberStatus", "documentation": "The phone number status.
", "location": "querystring", "locationName": "status" }, "ProductType": { "shape": "PhoneNumberProductType", "documentation": "The phone number product type.
", "location": "querystring", "locationName": "product-type" }, "FilterName": { "shape": "PhoneNumberAssociationName", "documentation": "The filter to use to limit the number of results.
", "location": "querystring", "locationName": "filter-name" }, "FilterValue": { "shape": "String", "documentation": "The value to use for the filter.
", "location": "querystring", "locationName": "filter-value" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" } } }, "ListPhoneNumbersResponse": { "type": "structure", "members": { "PhoneNumbers": { "shape": "PhoneNumberList", "documentation": "The phone number details.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListProxySessionsRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime voice connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "Status": { "shape": "ProxySessionStatus", "documentation": "The proxy session status.
", "location": "querystring", "locationName": "status" }, "NextToken": { "shape": "NextTokenString", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" } } }, "ListProxySessionsResponse": { "type": "structure", "members": { "ProxySessions": { "shape": "ProxySessions", "documentation": "The proxy session details.
" }, "NextToken": { "shape": "NextTokenString", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListRoomMembershipsRequest": { "type": "structure", "required": [ "AccountId", "RoomId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
", "location": "uri", "locationName": "roomId" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" } } }, "ListRoomMembershipsResponse": { "type": "structure", "members": { "RoomMemberships": { "shape": "RoomMembershipList", "documentation": "The room membership details.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListRoomsRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "MemberId": { "shape": "String", "documentation": "The member ID (user ID or bot ID).
", "location": "querystring", "locationName": "member-id" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" } } }, "ListRoomsResponse": { "type": "structure", "members": { "Rooms": { "shape": "RoomList", "documentation": "The room details.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListSipMediaApplicationsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call. Defaults to 100.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextTokenString", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" } } }, "ListSipMediaApplicationsResponse": { "type": "structure", "members": { "SipMediaApplications": { "shape": "SipMediaApplicationList", "documentation": "List of SIP media applications and application details.
" }, "NextToken": { "shape": "NextTokenString", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListSipRulesRequest": { "type": "structure", "members": { "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The SIP media application ID.
", "location": "querystring", "locationName": "sip-media-application" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call. Defaults to 100.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "NextTokenString", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" } } }, "ListSipRulesResponse": { "type": "structure", "members": { "SipRules": { "shape": "SipRuleList", "documentation": "List of SIP rules and rule details.
" }, "NextToken": { "shape": "NextTokenString", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListSupportedPhoneNumberCountriesRequest": { "type": "structure", "required": [ "ProductType" ], "members": { "ProductType": { "shape": "PhoneNumberProductType", "documentation": "The phone number product type.
", "location": "querystring", "locationName": "product-type" } } }, "ListSupportedPhoneNumberCountriesResponse": { "type": "structure", "members": { "PhoneNumberCountries": { "shape": "PhoneNumberCountriesList", "documentation": "The supported phone number countries.
" } } }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ResourceARN" ], "members": { "ResourceARN": { "shape": "Arn", "documentation": "The resource ARN.
", "location": "querystring", "locationName": "arn" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "shape": "TagList", "documentation": "A list of tag-key value pairs.
" } } }, "ListUsersRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserEmail": { "shape": "EmailAddress", "documentation": "Optional. The user email address used to filter results. Maximum 1.
", "location": "querystring", "locationName": "user-email" }, "UserType": { "shape": "UserType", "documentation": "The user type.
", "location": "querystring", "locationName": "user-type" }, "MaxResults": { "shape": "ProfileServiceMaxResults", "documentation": "The maximum number of results to return in a single call. Defaults to 100.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" } } }, "ListUsersResponse": { "type": "structure", "members": { "Users": { "shape": "UserList", "documentation": "List of users and user details.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListVoiceConnectorGroupsRequest": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" } } }, "ListVoiceConnectorGroupsResponse": { "type": "structure", "members": { "VoiceConnectorGroups": { "shape": "VoiceConnectorGroupList", "documentation": "The details of the Amazon Chime Voice Connector groups.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "ListVoiceConnectorTerminationCredentialsRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" } } }, "ListVoiceConnectorTerminationCredentialsResponse": { "type": "structure", "members": { "Usernames": { "shape": "SensitiveStringList", "documentation": "A list of user names.
" } } }, "ListVoiceConnectorsRequest": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" }, "MaxResults": { "shape": "ResultMax", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" } } }, "ListVoiceConnectorsResponse": { "type": "structure", "members": { "VoiceConnectors": { "shape": "VoiceConnectorList", "documentation": "The details of the Amazon Chime Voice Connectors.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" } } }, "LoggingConfiguration": { "type": "structure", "members": { "EnableSIPLogs": { "shape": "Boolean", "documentation": "Boolean that enables SIP message logs to Amazon CloudWatch logs.
" }, "EnableMediaMetricLogs": { "shape": "Boolean", "documentation": "Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
" } }, "documentation": "The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
" }, "LogoutUserRequest": { "type": "structure", "required": [ "AccountId", "UserId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserId": { "shape": "NonEmptyString", "documentation": "The user ID.
", "location": "uri", "locationName": "userId" } } }, "LogoutUserResponse": { "type": "structure", "members": {} }, "MaxResults": { "type": "integer", "max": 50, "min": 1 }, "MediaCapturePipeline": { "type": "structure", "members": { "MediaPipelineId": { "shape": "GuidString", "documentation": "The ID of a media capture pipeline.
" }, "SourceType": { "shape": "MediaPipelineSourceType", "documentation": "Source type from which media artifacts are saved. You must use ChimeMeeting
.
ARN of the source from which the media artifacts will be saved.
" }, "Status": { "shape": "MediaPipelineStatus", "documentation": "The status of the media capture pipeline.
" }, "SinkType": { "shape": "MediaPipelineSinkType", "documentation": "Destination type to which the media artifacts are saved. You must use an S3 Bucket.
" }, "SinkArn": { "shape": "Arn", "documentation": "ARN of the destination to which the media artifacts are saved.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The time at which the capture pipeline was created, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The time at which the capture pipeline was updated, in ISO 8601 format.
" }, "ChimeSdkMeetingConfiguration": { "shape": "ChimeSdkMeetingConfiguration", "documentation": "The configuration for a specified media capture pipeline. SourceType
must be ChimeSdkMeeting
.
A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.
" }, "MediaCapturePipelineList": { "type": "list", "member": { "shape": "MediaCapturePipeline" } }, "MediaPipelineSinkType": { "type": "string", "enum": [ "S3Bucket" ] }, "MediaPipelineSourceType": { "type": "string", "enum": [ "ChimeSdkMeeting" ] }, "MediaPipelineStatus": { "type": "string", "enum": [ "Initializing", "InProgress", "Failed", "Stopping", "Stopped" ] }, "MediaPlacement": { "type": "structure", "members": { "AudioHostUrl": { "shape": "UriType", "documentation": "The audio host URL.
" }, "AudioFallbackUrl": { "shape": "UriType", "documentation": "The audio fallback URL.
" }, "ScreenDataUrl": { "shape": "UriType", "documentation": "The screen data URL.
This parameter is is no longer supported and no longer used by the Amazon Chime SDK.
The screen sharing URL.
This parameter is is no longer supported and no longer used by the Amazon Chime SDK..
The screen viewing URL.
This parameter is is no longer supported and no longer used by the Amazon Chime SDK.
The signaling URL.
" }, "TurnControlUrl": { "shape": "UriType", "documentation": "The turn control URL.
This parameter is is no longer supported and no longer used by the Amazon Chime SDK.
The event ingestion URL to which you send client meeting events.
" } }, "documentation": "A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
" }, "Meeting": { "type": "structure", "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
" }, "ExternalMeetingId": { "shape": "ExternalMeetingIdType", "documentation": "The external meeting ID.
" }, "MediaPlacement": { "shape": "MediaPlacement", "documentation": "The media placement for the meeting.
" }, "MediaRegion": { "shape": "String", "documentation": "The Region in which you create the meeting. Available values: af-south-1
, ap-northeast-1
, ap-northeast-2
, ap-south-1
, ap-southeast-1
, ap-southeast-2
, ca-central-1
, eu-central-1
, eu-north-1
, eu-south-1
, eu-west-1
, eu-west-2
, eu-west-3
, sa-east-1
, us-east-1
, us-east-2
, us-west-1
, us-west-2
.
A meeting created using the Amazon Chime SDK.
" }, "MeetingList": { "type": "list", "member": { "shape": "Meeting" } }, "MeetingNotificationConfiguration": { "type": "structure", "members": { "SnsTopicArn": { "shape": "Arn", "documentation": "The SNS topic ARN.
" }, "SqsQueueArn": { "shape": "Arn", "documentation": "The SQS queue ARN.
" } }, "documentation": " The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1
).
The member ID (user ID or bot ID).
" }, "MemberType": { "shape": "MemberType", "documentation": "The member type.
" }, "Email": { "shape": "SensitiveString", "documentation": "The member email address.
" }, "FullName": { "shape": "SensitiveString", "documentation": "The member name.
" }, "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
" } }, "documentation": "The member details, such as email address, name, member ID, and member type.
" }, "MemberArns": { "type": "list", "member": { "shape": "ChimeArn" }, "max": 100, "min": 1 }, "MemberError": { "type": "structure", "members": { "MemberId": { "shape": "NonEmptyString", "documentation": "The member ID.
" }, "ErrorCode": { "shape": "ErrorCode", "documentation": "The error code.
" }, "ErrorMessage": { "shape": "String", "documentation": "The error message.
" } }, "documentation": "The list of errors returned when a member action results in an error.
" }, "MemberErrorList": { "type": "list", "member": { "shape": "MemberError" } }, "MemberType": { "type": "string", "enum": [ "User", "Bot", "Webhook" ] }, "Members": { "type": "list", "member": { "shape": "Identity" } }, "MembershipItem": { "type": "structure", "members": { "MemberId": { "shape": "NonEmptyString", "documentation": "The member ID.
" }, "Role": { "shape": "RoomMembershipRole", "documentation": "The member role.
" } }, "documentation": "Membership details, such as member ID and member role.
" }, "MembershipItemList": { "type": "list", "member": { "shape": "MembershipItem" }, "max": 50 }, "MessageId": { "type": "string", "max": 128, "min": 1, "pattern": "[-_a-zA-Z0-9]*" }, "MessagingSessionEndpoint": { "type": "structure", "members": { "Url": { "shape": "UrlType", "documentation": "The endpoint to which you establish a websocket connection.
" } }, "documentation": "The websocket endpoint used to connect to Amazon Chime SDK messaging.
" }, "Metadata": { "type": "string", "max": 1024, "min": 0, "pattern": ".*", "sensitive": true }, "NextToken": { "type": "string", "max": 2048, "min": 0, "pattern": ".*", "sensitive": true }, "NextTokenString": { "type": "string", "max": 65535 }, "NonEmptyContent": { "type": "string", "min": 1, "pattern": "[\\s\\S]*", "sensitive": true }, "NonEmptyResourceName": { "type": "string", "max": 256, "min": 1, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "sensitive": true }, "NonEmptyString": { "type": "string", "pattern": ".*\\S.*" }, "NonEmptyString128": { "type": "string", "max": 128, "min": 1, "pattern": ".*\\S.*" }, "NonEmptyStringList": { "type": "list", "member": { "shape": "String" }, "min": 1 }, "NonNullableBoolean": { "type": "boolean" }, "NotificationTarget": { "type": "string", "enum": [ "EventBridge", "SNS", "SQS" ] }, "NullableBoolean": { "type": "boolean" }, "NumberSelectionBehavior": { "type": "string", "enum": [ "PreferSticky", "AvoidSticky" ] }, "OrderedPhoneNumber": { "type": "structure", "members": { "E164PhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The phone number, in E.164 format.
" }, "Status": { "shape": "OrderedPhoneNumberStatus", "documentation": "The phone number status.
" } }, "documentation": "A phone number for which an order has been placed.
" }, "OrderedPhoneNumberList": { "type": "list", "member": { "shape": "OrderedPhoneNumber" } }, "OrderedPhoneNumberStatus": { "type": "string", "enum": [ "Processing", "Acquired", "Failed" ] }, "Origination": { "type": "structure", "members": { "Routes": { "shape": "OriginationRouteList", "documentation": "The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled
.
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes
.
Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector.
The parameters listed below are not required, but you must use at least one.
The FQDN or IP address to contact for origination traffic.
" }, "Port": { "shape": "Port", "documentation": "The designated origination route port. Defaults to 5060.
" }, "Protocol": { "shape": "OriginationRouteProtocol", "documentation": "The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
" }, "Priority": { "shape": "OriginationRoutePriority", "documentation": "The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
" }, "Weight": { "shape": "OriginationRouteWeight", "documentation": "The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
" } }, "documentation": "Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.
The parameters listed below are not required, but you must use at least one.
The participant's phone number.
" }, "ProxyPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The participant's proxy phone number.
" } }, "documentation": "The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
" }, "ParticipantPhoneNumberList": { "type": "list", "member": { "shape": "E164PhoneNumber" }, "max": 2, "min": 2 }, "Participants": { "type": "list", "member": { "shape": "Participant" } }, "PhoneNumber": { "type": "structure", "members": { "PhoneNumberId": { "shape": "String", "documentation": "The phone number ID.
" }, "E164PhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The phone number, in E.164 format.
" }, "Country": { "shape": "Alpha2CountryCode", "documentation": "The phone number country. Format: ISO 3166-1 alpha-2.
" }, "Type": { "shape": "PhoneNumberType", "documentation": "The phone number type.
" }, "ProductType": { "shape": "PhoneNumberProductType", "documentation": "The phone number product type.
" }, "Status": { "shape": "PhoneNumberStatus", "documentation": "The phone number status.
" }, "Capabilities": { "shape": "PhoneNumberCapabilities", "documentation": "The phone number capabilities.
" }, "Associations": { "shape": "PhoneNumberAssociationList", "documentation": "The phone number associations.
" }, "CallingName": { "shape": "CallingName", "documentation": "The outbound calling name associated with the phone number.
" }, "CallingNameStatus": { "shape": "CallingNameStatus", "documentation": "The outbound calling name status.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The phone number creation timestamp, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The updated phone number timestamp, in ISO 8601 format.
" }, "DeletionTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The deleted phone number timestamp, in ISO 8601 format.
" } }, "documentation": "A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.
" }, "PhoneNumberAssociation": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "Contains the ID for the entity specified in Name.
" }, "Name": { "shape": "PhoneNumberAssociationName", "documentation": "Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
" }, "AssociatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The timestamp of the phone number association, in ISO 8601 format.
" } }, "documentation": "The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
" }, "PhoneNumberAssociationList": { "type": "list", "member": { "shape": "PhoneNumberAssociation" } }, "PhoneNumberAssociationName": { "type": "string", "enum": [ "AccountId", "UserId", "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId" ] }, "PhoneNumberCapabilities": { "type": "structure", "members": { "InboundCall": { "shape": "NullableBoolean", "documentation": "Allows or denies inbound calling for the specified phone number.
" }, "OutboundCall": { "shape": "NullableBoolean", "documentation": "Allows or denies outbound calling for the specified phone number.
" }, "InboundSMS": { "shape": "NullableBoolean", "documentation": "Allows or denies inbound SMS messaging for the specified phone number.
" }, "OutboundSMS": { "shape": "NullableBoolean", "documentation": "Allows or denies outbound SMS messaging for the specified phone number.
" }, "InboundMMS": { "shape": "NullableBoolean", "documentation": "Allows or denies inbound MMS messaging for the specified phone number.
" }, "OutboundMMS": { "shape": "NullableBoolean", "documentation": "Allows or denies outbound MMS messaging for the specified phone number.
" } }, "documentation": "The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.
" }, "PhoneNumberCountriesList": { "type": "list", "member": { "shape": "PhoneNumberCountry" } }, "PhoneNumberCountry": { "type": "structure", "members": { "CountryCode": { "shape": "Alpha2CountryCode", "documentation": "The phone number country code. Format: ISO 3166-1 alpha-2.
" }, "SupportedPhoneNumberTypes": { "shape": "PhoneNumberTypeList", "documentation": "The supported phone number types.
" } }, "documentation": "The phone number country.
" }, "PhoneNumberError": { "type": "structure", "members": { "PhoneNumberId": { "shape": "NonEmptyString", "documentation": "The phone number ID for which the action failed.
" }, "ErrorCode": { "shape": "ErrorCode", "documentation": "The error code.
" }, "ErrorMessage": { "shape": "String", "documentation": "The error message.
" } }, "documentation": "If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
" }, "PhoneNumberErrorList": { "type": "list", "member": { "shape": "PhoneNumberError" } }, "PhoneNumberList": { "type": "list", "member": { "shape": "PhoneNumber" } }, "PhoneNumberMaxResults": { "type": "integer", "max": 500, "min": 1 }, "PhoneNumberOrder": { "type": "structure", "members": { "PhoneNumberOrderId": { "shape": "GuidString", "documentation": "The phone number order ID.
" }, "ProductType": { "shape": "PhoneNumberProductType", "documentation": "The phone number order product type.
" }, "Status": { "shape": "PhoneNumberOrderStatus", "documentation": "The status of the phone number order.
" }, "OrderedPhoneNumbers": { "shape": "OrderedPhoneNumberList", "documentation": "The ordered phone number details, such as the phone number in E.164 format and the phone number status.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The phone number order creation time stamp, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The updated phone number order time stamp, in ISO 8601 format.
" } }, "documentation": "The details of a phone number order created for Amazon Chime.
" }, "PhoneNumberOrderList": { "type": "list", "member": { "shape": "PhoneNumberOrder" } }, "PhoneNumberOrderStatus": { "type": "string", "enum": [ "Processing", "Successful", "Failed", "Partial" ] }, "PhoneNumberProductType": { "type": "string", "enum": [ "BusinessCalling", "VoiceConnector", "SipMediaApplicationDialIn" ] }, "PhoneNumberStatus": { "type": "string", "enum": [ "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed" ] }, "PhoneNumberType": { "type": "string", "enum": [ "Local", "TollFree" ] }, "PhoneNumberTypeList": { "type": "list", "member": { "shape": "PhoneNumberType" } }, "Port": { "type": "integer", "max": 65535, "min": 0 }, "PositiveInteger": { "type": "integer", "min": 1 }, "ProfileServiceMaxResults": { "type": "integer", "max": 200, "min": 1 }, "Proxy": { "type": "structure", "members": { "DefaultSessionExpiryMinutes": { "shape": "Integer", "documentation": "The default number of minutes allowed for proxy sessions.
" }, "Disabled": { "shape": "Boolean", "documentation": "When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
" }, "FallBackPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The phone number to route calls to after a proxy session expires.
" }, "PhoneNumberCountries": { "shape": "StringList", "documentation": "The countries for proxy phone numbers to be selected from.
" } }, "documentation": "The proxy configuration for an Amazon Chime Voice Connector.
" }, "ProxySession": { "type": "structure", "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime voice connector ID.
" }, "ProxySessionId": { "shape": "NonEmptyString128", "documentation": "The proxy session ID.
" }, "Name": { "shape": "String128", "documentation": "The name of the proxy session.
" }, "Status": { "shape": "ProxySessionStatus", "documentation": "The status of the proxy session.
" }, "ExpiryMinutes": { "shape": "PositiveInteger", "documentation": "The number of minutes allowed for the proxy session.
" }, "Capabilities": { "shape": "CapabilityList", "documentation": "The proxy session capabilities.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The created time stamp, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The updated time stamp, in ISO 8601 format.
" }, "EndedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The ended time stamp, in ISO 8601 format.
" }, "Participants": { "shape": "Participants", "documentation": "The proxy session participants.
" }, "NumberSelectionBehavior": { "shape": "NumberSelectionBehavior", "documentation": "The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
" }, "GeoMatchLevel": { "shape": "GeoMatchLevel", "documentation": "The preference for matching the country or area code of the proxy phone number with that of the first participant.
" }, "GeoMatchParams": { "shape": "GeoMatchParams", "documentation": "The country and area code for the proxy phone number.
" } }, "documentation": "The proxy session for an Amazon Chime Voice Connector.
" }, "ProxySessionNameString": { "type": "string", "pattern": "^$|^[a-zA-Z0-9 ]{0,30}$", "sensitive": true }, "ProxySessionStatus": { "type": "string", "enum": [ "Open", "InProgress", "Closed" ] }, "ProxySessions": { "type": "list", "member": { "shape": "ProxySession" } }, "PutAppInstanceRetentionSettingsRequest": { "type": "structure", "required": [ "AppInstanceArn", "AppInstanceRetentionSettings" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The time in days to retain data. Data type: number.
" } } }, "PutAppInstanceRetentionSettingsResponse": { "type": "structure", "members": { "AppInstanceRetentionSettings": { "shape": "AppInstanceRetentionSettings", "documentation": "The time in days to retain data. Data type: number.
" }, "InitiateDeletionTimestamp": { "shape": "Timestamp", "documentation": "The time at which the API deletes data.
" } } }, "PutAppInstanceStreamingConfigurationsRequest": { "type": "structure", "required": [ "AppInstanceArn", "AppInstanceStreamingConfigurations" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The streaming configurations set for an AppInstance
.
The streaming configurations of an AppInstance
.
The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "BotId": { "shape": "NonEmptyString", "documentation": "The bot ID.
", "location": "uri", "locationName": "botId" }, "OutboundEventsHTTPSEndpoint": { "shape": "SensitiveString", "documentation": "HTTPS endpoint that allows the bot to receive outgoing events.
" }, "LambdaFunctionArn": { "shape": "SensitiveString", "documentation": "Lambda function ARN that allows the bot to receive outgoing events.
" } } }, "PutEventsConfigurationResponse": { "type": "structure", "members": { "EventsConfiguration": { "shape": "EventsConfiguration", "documentation": "The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an AWS Lambda function ARN.
" } } }, "PutRetentionSettingsRequest": { "type": "structure", "required": [ "AccountId", "RetentionSettings" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RetentionSettings": { "shape": "RetentionSettings", "documentation": "The retention settings.
" } } }, "PutRetentionSettingsResponse": { "type": "structure", "members": { "RetentionSettings": { "shape": "RetentionSettings", "documentation": "The retention settings.
" }, "InitiateDeletionTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
" } } }, "PutSipMediaApplicationLoggingConfigurationRequest": { "type": "structure", "required": [ "SipMediaApplicationId" ], "members": { "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The SIP media application ID.
", "location": "uri", "locationName": "sipMediaApplicationId" }, "SipMediaApplicationLoggingConfiguration": { "shape": "SipMediaApplicationLoggingConfiguration", "documentation": "The actual logging configuration.
" } } }, "PutSipMediaApplicationLoggingConfigurationResponse": { "type": "structure", "members": { "SipMediaApplicationLoggingConfiguration": { "shape": "SipMediaApplicationLoggingConfiguration", "documentation": "The logging configuration of the SIP media application.
" } } }, "PutVoiceConnectorEmergencyCallingConfigurationRequest": { "type": "structure", "required": [ "VoiceConnectorId", "EmergencyCallingConfiguration" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "EmergencyCallingConfiguration": { "shape": "EmergencyCallingConfiguration", "documentation": "The emergency calling configuration details.
" } } }, "PutVoiceConnectorEmergencyCallingConfigurationResponse": { "type": "structure", "members": { "EmergencyCallingConfiguration": { "shape": "EmergencyCallingConfiguration", "documentation": "The emergency calling configuration details.
" } } }, "PutVoiceConnectorLoggingConfigurationRequest": { "type": "structure", "required": [ "VoiceConnectorId", "LoggingConfiguration" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "LoggingConfiguration": { "shape": "LoggingConfiguration", "documentation": "The logging configuration details to add.
" } } }, "PutVoiceConnectorLoggingConfigurationResponse": { "type": "structure", "members": { "LoggingConfiguration": { "shape": "LoggingConfiguration", "documentation": "The updated logging configuration details.
" } } }, "PutVoiceConnectorOriginationRequest": { "type": "structure", "required": [ "VoiceConnectorId", "Origination" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "Origination": { "shape": "Origination", "documentation": "The origination setting details to add.
" } } }, "PutVoiceConnectorOriginationResponse": { "type": "structure", "members": { "Origination": { "shape": "Origination", "documentation": "The updated origination setting details.
" } } }, "PutVoiceConnectorProxyRequest": { "type": "structure", "required": [ "DefaultSessionExpiryMinutes", "PhoneNumberPoolCountries", "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime voice connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "DefaultSessionExpiryMinutes": { "shape": "Integer", "documentation": "The default number of minutes allowed for proxy sessions.
" }, "PhoneNumberPoolCountries": { "shape": "CountryList", "documentation": "The countries for proxy phone numbers to be selected from.
" }, "FallBackPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The phone number to route calls to after a proxy session expires.
" }, "Disabled": { "shape": "Boolean", "documentation": "When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
" } } }, "PutVoiceConnectorProxyResponse": { "type": "structure", "members": { "Proxy": { "shape": "Proxy", "documentation": "The proxy configuration details.
" } } }, "PutVoiceConnectorStreamingConfigurationRequest": { "type": "structure", "required": [ "VoiceConnectorId", "StreamingConfiguration" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "StreamingConfiguration": { "shape": "StreamingConfiguration", "documentation": "The streaming configuration details to add.
" } } }, "PutVoiceConnectorStreamingConfigurationResponse": { "type": "structure", "members": { "StreamingConfiguration": { "shape": "StreamingConfiguration", "documentation": "The updated streaming configuration details.
" } } }, "PutVoiceConnectorTerminationCredentialsRequest": { "type": "structure", "required": [ "VoiceConnectorId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "Credentials": { "shape": "CredentialList", "documentation": "The termination SIP credentials.
" } } }, "PutVoiceConnectorTerminationRequest": { "type": "structure", "required": [ "VoiceConnectorId", "Termination" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "Termination": { "shape": "Termination", "documentation": "The termination setting details to add.
" } } }, "PutVoiceConnectorTerminationResponse": { "type": "structure", "members": { "Termination": { "shape": "Termination", "documentation": "The updated termination setting details.
" } } }, "RedactChannelMessageRequest": { "type": "structure", "required": [ "ChannelArn", "MessageId" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel containing the messages that you want to redact.
", "location": "uri", "locationName": "channelArn" }, "MessageId": { "shape": "MessageId", "documentation": "The ID of the message being redacted.
", "location": "uri", "locationName": "messageId" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel containing the messages that you want to redact.
" }, "MessageId": { "shape": "MessageId", "documentation": "The ID of the message being redacted.
" } } }, "RedactConversationMessageRequest": { "type": "structure", "required": [ "AccountId", "ConversationId", "MessageId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "ConversationId": { "shape": "NonEmptyString", "documentation": "The conversation ID.
", "location": "uri", "locationName": "conversationId" }, "MessageId": { "shape": "NonEmptyString", "documentation": "The message ID.
", "location": "uri", "locationName": "messageId" } } }, "RedactConversationMessageResponse": { "type": "structure", "members": {} }, "RedactRoomMessageRequest": { "type": "structure", "required": [ "AccountId", "RoomId", "MessageId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
", "location": "uri", "locationName": "roomId" }, "MessageId": { "shape": "NonEmptyString", "documentation": "The message ID.
", "location": "uri", "locationName": "messageId" } } }, "RedactRoomMessageResponse": { "type": "structure", "members": {} }, "RegenerateSecurityTokenRequest": { "type": "structure", "required": [ "AccountId", "BotId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "BotId": { "shape": "NonEmptyString", "documentation": "The bot ID.
", "location": "uri", "locationName": "botId" } } }, "RegenerateSecurityTokenResponse": { "type": "structure", "members": { "Bot": { "shape": "Bot", "documentation": "A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.
" } } }, "RegistrationStatus": { "type": "string", "enum": [ "Unregistered", "Registered", "Suspended" ] }, "ResetPersonalPINRequest": { "type": "structure", "required": [ "AccountId", "UserId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserId": { "shape": "NonEmptyString", "documentation": "The user ID.
", "location": "uri", "locationName": "userId" } } }, "ResetPersonalPINResponse": { "type": "structure", "members": { "User": { "shape": "User", "documentation": "The user details and new personal meeting PIN.
" } } }, "ResourceName": { "type": "string", "max": 256, "min": 0, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "sensitive": true }, "RestorePhoneNumberRequest": { "type": "structure", "required": [ "PhoneNumberId" ], "members": { "PhoneNumberId": { "shape": "NonEmptyString", "documentation": "The phone number.
", "location": "uri", "locationName": "phoneNumberId" } } }, "RestorePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumber": { "shape": "PhoneNumber", "documentation": "The phone number details.
" } } }, "ResultMax": { "type": "integer", "max": 99, "min": 1 }, "RetentionDays": { "type": "integer", "max": 5475, "min": 1 }, "RetentionSettings": { "type": "structure", "members": { "RoomRetentionSettings": { "shape": "RoomRetentionSettings", "documentation": "The chat room retention settings.
" }, "ConversationRetentionSettings": { "shape": "ConversationRetentionSettings", "documentation": "The chat conversation retention settings.
" } }, "documentation": "The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat-room messages and chat-conversation messages.
" }, "Room": { "type": "structure", "members": { "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
" }, "Name": { "shape": "SensitiveString", "documentation": "The room name.
" }, "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
" }, "CreatedBy": { "shape": "NonEmptyString", "documentation": "The identifier of the room creator.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The room creation timestamp, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The room update timestamp, in ISO 8601 format.
" } }, "documentation": "The Amazon Chime chat room details.
" }, "RoomList": { "type": "list", "member": { "shape": "Room" } }, "RoomMembership": { "type": "structure", "members": { "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
" }, "Member": { "shape": "Member", "documentation": "The member details, such as email address, name, member ID, and member type.
" }, "Role": { "shape": "RoomMembershipRole", "documentation": "The membership role.
" }, "InvitedBy": { "shape": "NonEmptyString", "documentation": "The identifier of the user that invited the room member.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The room membership update timestamp, in ISO 8601 format.
" } }, "documentation": "The room membership details.
" }, "RoomMembershipList": { "type": "list", "member": { "shape": "RoomMembership" } }, "RoomMembershipRole": { "type": "string", "enum": [ "Administrator", "Member" ] }, "RoomRetentionSettings": { "type": "structure", "members": { "RetentionDays": { "shape": "RetentionDays", "documentation": "The number of days for which to retain chat-room messages.
" } }, "documentation": "The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.
" }, "SMAUpdateCallArgumentsMap": { "type": "map", "key": { "shape": "SensitiveString" }, "value": { "shape": "SensitiveString" }, "max": 20, "min": 0 }, "SearchAvailablePhoneNumbersRequest": { "type": "structure", "members": { "AreaCode": { "shape": "String", "documentation": "The area code used to filter results. Only applies to the US.
", "location": "querystring", "locationName": "area-code" }, "City": { "shape": "String", "documentation": "The city used to filter results. Only applies to the US.
", "location": "querystring", "locationName": "city" }, "Country": { "shape": "Alpha2CountryCode", "documentation": "The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
", "location": "querystring", "locationName": "country" }, "State": { "shape": "String", "documentation": "The state used to filter results. Required only if you provide City
. Only applies to the US.
The toll-free prefix that you use to filter results. Only applies to the US.
", "location": "querystring", "locationName": "toll-free-prefix" }, "PhoneNumberType": { "shape": "PhoneNumberType", "documentation": "The phone number type used to filter results. Required for non-US numbers.
", "location": "querystring", "locationName": "phone-number-type" }, "MaxResults": { "shape": "PhoneNumberMaxResults", "documentation": "The maximum number of results to return in a single call.
", "location": "querystring", "locationName": "max-results" }, "NextToken": { "shape": "String", "documentation": "The token used to retrieve the next page of results.
", "location": "querystring", "locationName": "next-token" } } }, "SearchAvailablePhoneNumbersResponse": { "type": "structure", "members": { "E164PhoneNumbers": { "shape": "E164PhoneNumberList", "documentation": "List of phone numbers, in E.164 format.
" }, "NextToken": { "shape": "String", "documentation": "The token used to retrieve the next page of search results.
" } } }, "SelectedVideoStreams": { "type": "structure", "members": { "AttendeeIds": { "shape": "AttendeeIdList", "documentation": "The attendee IDs of the streams selected for a media capture pipeline.
" }, "ExternalUserIds": { "shape": "ExternalUserIdList", "documentation": "The external user IDs of the streams selected for a media capture pipeline.
" } }, "documentation": "The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.
" }, "SendChannelMessageRequest": { "type": "structure", "required": [ "ChannelArn", "Content", "Type", "Persistence", "ClientRequestToken" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "Content": { "shape": "NonEmptyContent", "documentation": "The content of the message.
" }, "Type": { "shape": "ChannelMessageType", "documentation": "The type of message, STANDARD
or CONTROL
.
Boolean that controls whether the message is persisted on the back end. Required.
" }, "Metadata": { "shape": "Metadata", "documentation": "The optional metadata for each message.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "The Idempotency
token for each client request.
The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" }, "MessageId": { "shape": "MessageId", "documentation": "The ID string assigned to each message.
" } } }, "SensitiveNonEmptyString": { "type": "string", "pattern": ".*\\S.*", "sensitive": true }, "SensitiveString": { "type": "string", "sensitive": true }, "SensitiveStringList": { "type": "list", "member": { "shape": "SensitiveString" } }, "SigninDelegateGroup": { "type": "structure", "members": { "GroupName": { "shape": "NonEmptyString", "documentation": "The group name.
" } }, "documentation": "An Active Directory (AD) group whose members are granted permission to act as delegates.
" }, "SigninDelegateGroupList": { "type": "list", "member": { "shape": "SigninDelegateGroup" } }, "SipApplicationPriority": { "type": "integer", "min": 1 }, "SipHeadersMap": { "type": "map", "key": { "shape": "SensitiveString" }, "value": { "shape": "SensitiveString" }, "max": 20, "min": 0 }, "SipMediaApplication": { "type": "structure", "members": { "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The SIP media application ID.
" }, "AwsRegion": { "shape": "String", "documentation": "The AWS Region in which the SIP media application is created.
" }, "Name": { "shape": "SipMediaApplicationName", "documentation": "The name of the SIP media application.
" }, "Endpoints": { "shape": "SipMediaApplicationEndpointList", "documentation": "List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The SIP media application creation timestamp, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The SIP media application updated timestamp, in ISO 8601 format.
" } }, "documentation": "The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.
" }, "SipMediaApplicationCall": { "type": "structure", "members": { "TransactionId": { "shape": "GuidString", "documentation": "The transaction ID of a call.
" } }, "documentation": "A Call
instance for a SIP media application.
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
" } }, "documentation": "The endpoint assigned to the SIP media application.
" }, "SipMediaApplicationEndpointList": { "type": "list", "member": { "shape": "SipMediaApplicationEndpoint" }, "max": 1, "min": 1 }, "SipMediaApplicationList": { "type": "list", "member": { "shape": "SipMediaApplication" } }, "SipMediaApplicationLoggingConfiguration": { "type": "structure", "members": { "EnableSipMediaApplicationMessageLogs": { "shape": "Boolean", "documentation": "Enables application message logs for the SIP media application.
" } }, "documentation": "Logging configuration of the SIP media application.
" }, "SipMediaApplicationName": { "type": "string", "max": 256, "min": 1 }, "SipRule": { "type": "structure", "members": { "SipRuleId": { "shape": "NonEmptyString", "documentation": "The SIP rule ID.
" }, "Name": { "shape": "SipRuleName", "documentation": "The name of the SIP rule.
" }, "Disabled": { "shape": "Boolean", "documentation": "Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
" }, "TriggerType": { "shape": "SipRuleTriggerType", "documentation": "The type of trigger assigned to the SIP rule in TriggerValue
, currently RequestUriHostname
or ToPhoneNumber
.
If TriggerType
is RequestUriHostname
, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType
is ToPhoneNumber
, then the value can be a customer-owned phone number in E164 format. SipRule
is triggered when a SIP rule requests host name or ToPhoneNumber
matches in the incoming SIP request.
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The time at which the SIP rule was created, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The time at which the SIP rule was last updated, in ISO 8601 format.
" } }, "documentation": "The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.
" }, "SipRuleList": { "type": "list", "member": { "shape": "SipRule" } }, "SipRuleName": { "type": "string", "max": 256, "min": 1 }, "SipRuleTargetApplication": { "type": "structure", "members": { "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The SIP media application ID.
" }, "Priority": { "shape": "SipApplicationPriority", "documentation": "Priority of the SIP media application in the target list.
" }, "AwsRegion": { "shape": "String", "documentation": "The AWS Region of the target application.
" } }, "documentation": "Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
" }, "SipRuleTargetApplicationList": { "type": "list", "member": { "shape": "SipRuleTargetApplication" }, "max": 25, "min": 1 }, "SipRuleTriggerType": { "type": "string", "enum": [ "ToPhoneNumber", "RequestUriHostname" ] }, "SortOrder": { "type": "string", "enum": [ "ASCENDING", "DESCENDING" ] }, "SourceConfiguration": { "type": "structure", "members": { "SelectedVideoStreams": { "shape": "SelectedVideoStreams", "documentation": "The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
" } }, "documentation": "Source configuration for a specified media capture pipeline.
" }, "StartMeetingTranscriptionRequest": { "type": "structure", "required": [ "MeetingId", "TranscriptionConfiguration" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The unique ID of the meeting being transcribed.
", "location": "uri", "locationName": "meetingId" }, "TranscriptionConfiguration": { "shape": "TranscriptionConfiguration", "documentation": "The configuration for the current transcription operation. Must contain EngineTranscribeSettings
or EngineTranscribeMedicalSettings
.
The unique ID of the meeting for which you stop transcription.
", "location": "uri", "locationName": "meetingId" } } }, "StopMeetingTranscriptionResponse": { "type": "structure", "members": {} }, "StreamingConfiguration": { "type": "structure", "required": [ "DataRetentionInHours" ], "members": { "DataRetentionInHours": { "shape": "DataRetentionInHours", "documentation": "The retention period, in hours, for the Amazon Kinesis data.
" }, "Disabled": { "shape": "Boolean", "documentation": "When true, media streaming to Amazon Kinesis is turned off.
" }, "StreamingNotificationTargets": { "shape": "StreamingNotificationTargetList", "documentation": "The streaming notification targets.
" } }, "documentation": "The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.
" }, "StreamingNotificationTarget": { "type": "structure", "required": [ "NotificationTarget" ], "members": { "NotificationTarget": { "shape": "NotificationTarget", "documentation": "The streaming notification target.
" } }, "documentation": "The targeted recipient for a streaming configuration notification.
" }, "StreamingNotificationTargetList": { "type": "list", "member": { "shape": "StreamingNotificationTarget" }, "max": 3, "min": 1 }, "String": { "type": "string" }, "String128": { "type": "string", "max": 128 }, "StringList": { "type": "list", "member": { "shape": "String" } }, "Tag": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "TagKey", "documentation": "The key of the tag.
" }, "Value": { "shape": "TagValue", "documentation": "The value of the tag.
" } }, "documentation": "Describes a tag applied to a resource.
" }, "TagAttendeeRequest": { "type": "structure", "required": [ "MeetingId", "AttendeeId", "Tags" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "AttendeeId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK attendee ID.
", "location": "uri", "locationName": "attendeeId" }, "Tags": { "shape": "AttendeeTagList", "documentation": "The tag key-value pairs.
" } } }, "TagKey": { "type": "string", "max": 128, "min": 1, "sensitive": true }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 50, "min": 1 }, "TagList": { "type": "list", "member": { "shape": "Tag" }, "max": 50, "min": 1 }, "TagMeetingRequest": { "type": "structure", "required": [ "MeetingId", "Tags" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "Tags": { "shape": "MeetingTagList", "documentation": "The tag key-value pairs.
" } } }, "TagResourceRequest": { "type": "structure", "required": [ "ResourceARN", "Tags" ], "members": { "ResourceARN": { "shape": "Arn", "documentation": "The resource ARN.
" }, "Tags": { "shape": "TagList", "documentation": "The tag key-value pairs.
" } } }, "TagValue": { "type": "string", "max": 256, "min": 1, "sensitive": true }, "TelephonySettings": { "type": "structure", "required": [ "InboundCalling", "OutboundCalling", "SMS" ], "members": { "InboundCalling": { "shape": "Boolean", "documentation": "Allows or denies inbound calling.
" }, "OutboundCalling": { "shape": "Boolean", "documentation": "Allows or denies outbound calling.
" }, "SMS": { "shape": "Boolean", "documentation": "Allows or denies SMS messaging.
" } }, "documentation": "Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.
" }, "Termination": { "type": "structure", "members": { "CpsLimit": { "shape": "CpsLimit", "documentation": "The limit on calls per second. Max value based on account service quota. Default value of 1.
" }, "DefaultPhoneNumber": { "shape": "E164PhoneNumber", "documentation": "The default caller ID phone number.
" }, "CallingRegions": { "shape": "CallingRegionList", "documentation": "The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
" }, "CidrAllowedList": { "shape": "StringList", "documentation": "The IP addresses allowed to make calls, in CIDR format. Required.
" }, "Disabled": { "shape": "Boolean", "documentation": "When termination settings are disabled, outbound calls can not be made.
" } }, "documentation": "Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice Connector.
" }, "TerminationHealth": { "type": "structure", "members": { "Timestamp": { "shape": "Iso8601Timestamp", "documentation": "The timestamp, in ISO 8601 format.
" }, "Source": { "shape": "String", "documentation": "The source IP address.
" } }, "documentation": "The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS
message from your SIP infrastructure.
The transcription configuration settings passed to Amazon Transcribe.
" }, "EngineTranscribeMedicalSettings": { "shape": "EngineTranscribeMedicalSettings", "documentation": "The transcription configuration settings passed to Amazon Transcribe Medical.
" } }, "documentation": "The configuration for the current transcription operation. Must contain EngineTranscribeSettings
or EngineTranscribeMedicalSettings
.
The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "AttendeeId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK attendee ID.
", "location": "uri", "locationName": "attendeeId" }, "TagKeys": { "shape": "AttendeeTagKeyList", "documentation": "The tag keys.
" } } }, "UntagMeetingRequest": { "type": "structure", "required": [ "MeetingId", "TagKeys" ], "members": { "MeetingId": { "shape": "GuidString", "documentation": "The Amazon Chime SDK meeting ID.
", "location": "uri", "locationName": "meetingId" }, "TagKeys": { "shape": "MeetingTagKeyList", "documentation": "The tag keys.
" } } }, "UntagResourceRequest": { "type": "structure", "required": [ "ResourceARN", "TagKeys" ], "members": { "ResourceARN": { "shape": "Arn", "documentation": "The resource ARN.
" }, "TagKeys": { "shape": "TagKeyList", "documentation": "The tag keys.
" } } }, "UpdateAccountRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "Name": { "shape": "AccountName", "documentation": "The new name for the specified Amazon Chime account.
" }, "DefaultLicense": { "shape": "License", "documentation": "The default license applied when you add users to an Amazon Chime account.
" } } }, "UpdateAccountResponse": { "type": "structure", "members": { "Account": { "shape": "Account", "documentation": "The updated Amazon Chime account details.
" } } }, "UpdateAccountSettingsRequest": { "type": "structure", "required": [ "AccountId", "AccountSettings" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "AccountSettings": { "shape": "AccountSettings", "documentation": "The Amazon Chime account settings to update.
" } } }, "UpdateAccountSettingsResponse": { "type": "structure", "members": {} }, "UpdateAppInstanceRequest": { "type": "structure", "required": [ "AppInstanceArn", "Name" ], "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The name that you want to change.
" }, "Metadata": { "shape": "Metadata", "documentation": "The metadata that you want to change.
" } } }, "UpdateAppInstanceResponse": { "type": "structure", "members": { "AppInstanceArn": { "shape": "ChimeArn", "documentation": "The ARN of the AppInstance
.
The ARN of the AppInstanceUser
.
The name of the AppInstanceUser
.
The metadata of the AppInstanceUser
.
The ARN of the AppInstanceUser
.
The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "BotId": { "shape": "NonEmptyString", "documentation": "The bot ID.
", "location": "uri", "locationName": "botId" }, "Disabled": { "shape": "NullableBoolean", "documentation": "When true, stops the specified bot from running in your account.
" } } }, "UpdateBotResponse": { "type": "structure", "members": { "Bot": { "shape": "Bot", "documentation": "The updated bot details.
" } } }, "UpdateChannelMessageRequest": { "type": "structure", "required": [ "ChannelArn", "MessageId" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "MessageId": { "shape": "MessageId", "documentation": "The ID string of the message being updated.
", "location": "uri", "locationName": "messageId" }, "Content": { "shape": "Content", "documentation": "The content of the message being updated.
" }, "Metadata": { "shape": "Metadata", "documentation": "The metadata of the message being updated.
" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" }, "MessageId": { "shape": "MessageId", "documentation": "The ID string of the message being updated.
" } } }, "UpdateChannelReadMarkerRequest": { "type": "structure", "required": [ "ChannelArn" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" } } }, "UpdateChannelRequest": { "type": "structure", "required": [ "ChannelArn", "Name", "Mode" ], "members": { "ChannelArn": { "shape": "ChimeArn", "documentation": "The ARN of the channel.
", "location": "uri", "locationName": "channelArn" }, "Name": { "shape": "NonEmptyResourceName", "documentation": "The name of the channel.
" }, "Mode": { "shape": "ChannelMode", "documentation": "The mode of the update request.
" }, "Metadata": { "shape": "Metadata", "documentation": "The metadata for the update request.
" }, "ChimeBearer": { "shape": "ChimeArn", "documentation": "The AppInstanceUserArn
of the user that makes the API call.
The ARN of the channel.
" } } }, "UpdateGlobalSettingsRequest": { "type": "structure", "members": { "BusinessCalling": { "shape": "BusinessCallingSettings", "documentation": "The Amazon Chime Business Calling settings.
" }, "VoiceConnector": { "shape": "VoiceConnectorSettings", "documentation": "The Amazon Chime Voice Connector settings.
" } } }, "UpdatePhoneNumberRequest": { "type": "structure", "required": [ "PhoneNumberId" ], "members": { "PhoneNumberId": { "shape": "String", "documentation": "The phone number ID.
", "location": "uri", "locationName": "phoneNumberId" }, "ProductType": { "shape": "PhoneNumberProductType", "documentation": "The product type.
" }, "CallingName": { "shape": "CallingName", "documentation": "The outbound calling name associated with the phone number.
" } } }, "UpdatePhoneNumberRequestItem": { "type": "structure", "required": [ "PhoneNumberId" ], "members": { "PhoneNumberId": { "shape": "NonEmptyString", "documentation": "The phone number ID to update.
" }, "ProductType": { "shape": "PhoneNumberProductType", "documentation": "The product type to update.
" }, "CallingName": { "shape": "CallingName", "documentation": "The outbound calling name to update.
" } }, "documentation": "The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
" }, "UpdatePhoneNumberRequestItemList": { "type": "list", "member": { "shape": "UpdatePhoneNumberRequestItem" } }, "UpdatePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumber": { "shape": "PhoneNumber", "documentation": "The updated phone number details.
" } } }, "UpdatePhoneNumberSettingsRequest": { "type": "structure", "required": [ "CallingName" ], "members": { "CallingName": { "shape": "CallingName", "documentation": "The default outbound calling name for the account.
" } } }, "UpdateProxySessionRequest": { "type": "structure", "required": [ "Capabilities", "VoiceConnectorId", "ProxySessionId" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString128", "documentation": "The Amazon Chime voice connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "ProxySessionId": { "shape": "NonEmptyString128", "documentation": "The proxy session ID.
", "location": "uri", "locationName": "proxySessionId" }, "Capabilities": { "shape": "CapabilityList", "documentation": "The proxy session capabilities.
" }, "ExpiryMinutes": { "shape": "PositiveInteger", "documentation": "The number of minutes allowed for the proxy session.
" } } }, "UpdateProxySessionResponse": { "type": "structure", "members": { "ProxySession": { "shape": "ProxySession", "documentation": "The proxy session details.
" } } }, "UpdateRoomMembershipRequest": { "type": "structure", "required": [ "AccountId", "RoomId", "MemberId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
", "location": "uri", "locationName": "roomId" }, "MemberId": { "shape": "NonEmptyString", "documentation": "The member ID.
", "location": "uri", "locationName": "memberId" }, "Role": { "shape": "RoomMembershipRole", "documentation": "The role of the member.
" } } }, "UpdateRoomMembershipResponse": { "type": "structure", "members": { "RoomMembership": { "shape": "RoomMembership", "documentation": "The room membership details.
" } } }, "UpdateRoomRequest": { "type": "structure", "required": [ "AccountId", "RoomId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "RoomId": { "shape": "NonEmptyString", "documentation": "The room ID.
", "location": "uri", "locationName": "roomId" }, "Name": { "shape": "SensitiveString", "documentation": "The room name.
" } } }, "UpdateRoomResponse": { "type": "structure", "members": { "Room": { "shape": "Room", "documentation": "The room details.
" } } }, "UpdateSipMediaApplicationCallRequest": { "type": "structure", "required": [ "SipMediaApplicationId", "TransactionId", "Arguments" ], "members": { "SipMediaApplicationId": { "shape": "NonEmptyString", "documentation": "The ID of the SIP media application handling the call.
", "location": "uri", "locationName": "sipMediaApplicationId" }, "TransactionId": { "shape": "NonEmptyString", "documentation": "The ID of the call transaction.
", "location": "uri", "locationName": "transactionId" }, "Arguments": { "shape": "SMAUpdateCallArgumentsMap", "documentation": "Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED
event. Can contain 0-20 key-value pairs.
A Call
instance for a SIP media application.
The SIP media application ID.
", "location": "uri", "locationName": "sipMediaApplicationId" }, "Name": { "shape": "SipMediaApplicationName", "documentation": "The new name for the specified SIP media application.
" }, "Endpoints": { "shape": "SipMediaApplicationEndpointList", "documentation": "The new set of endpoints for the specified SIP media application.
" } } }, "UpdateSipMediaApplicationResponse": { "type": "structure", "members": { "SipMediaApplication": { "shape": "SipMediaApplication", "documentation": "The updated SIP media application details.
" } } }, "UpdateSipRuleRequest": { "type": "structure", "required": [ "SipRuleId", "Name" ], "members": { "SipRuleId": { "shape": "NonEmptyString", "documentation": "The SIP rule ID.
", "location": "uri", "locationName": "sipRuleId" }, "Name": { "shape": "SipRuleName", "documentation": "The new name for the specified SIP rule.
" }, "Disabled": { "shape": "NullableBoolean", "documentation": "The new value specified to indicate whether the rule is disabled.
" }, "TargetApplications": { "shape": "SipRuleTargetApplicationList", "documentation": "The new value of the list of target applications.
" } } }, "UpdateSipRuleResponse": { "type": "structure", "members": { "SipRule": { "shape": "SipRule", "documentation": "Updated SIP rule details.
" } } }, "UpdateUserRequest": { "type": "structure", "required": [ "AccountId", "UserId" ], "members": { "AccountId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserId": { "shape": "NonEmptyString", "documentation": "The user ID.
", "location": "uri", "locationName": "userId" }, "LicenseType": { "shape": "License", "documentation": "The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
" }, "UserType": { "shape": "UserType", "documentation": "The user type.
" }, "AlexaForBusinessMetadata": { "shape": "AlexaForBusinessMetadata", "documentation": "The Alexa for Business metadata.
" } } }, "UpdateUserRequestItem": { "type": "structure", "required": [ "UserId" ], "members": { "UserId": { "shape": "NonEmptyString", "documentation": "The user ID.
" }, "LicenseType": { "shape": "License", "documentation": "The user license type.
" }, "UserType": { "shape": "UserType", "documentation": "The user type.
" }, "AlexaForBusinessMetadata": { "shape": "AlexaForBusinessMetadata", "documentation": "The Alexa for Business metadata.
" } }, "documentation": "The user ID and user fields to update, used with the BatchUpdateUser action.
" }, "UpdateUserRequestItemList": { "type": "list", "member": { "shape": "UpdateUserRequestItem" }, "max": 20 }, "UpdateUserResponse": { "type": "structure", "members": { "User": { "shape": "User", "documentation": "The updated user details.
" } } }, "UpdateUserSettingsRequest": { "type": "structure", "required": [ "AccountId", "UserId", "UserSettings" ], "members": { "AccountId": { "shape": "String", "documentation": "The Amazon Chime account ID.
", "location": "uri", "locationName": "accountId" }, "UserId": { "shape": "String", "documentation": "The user ID.
", "location": "uri", "locationName": "userId" }, "UserSettings": { "shape": "UserSettings", "documentation": "The user settings to update.
" } } }, "UpdateVoiceConnectorGroupRequest": { "type": "structure", "required": [ "VoiceConnectorGroupId", "Name", "VoiceConnectorItems" ], "members": { "VoiceConnectorGroupId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector group ID.
", "location": "uri", "locationName": "voiceConnectorGroupId" }, "Name": { "shape": "VoiceConnectorGroupName", "documentation": "The name of the Amazon Chime Voice Connector group.
" }, "VoiceConnectorItems": { "shape": "VoiceConnectorItemList", "documentation": "The VoiceConnectorItems
to associate with the group.
The updated Amazon Chime Voice Connector group details.
" } } }, "UpdateVoiceConnectorRequest": { "type": "structure", "required": [ "VoiceConnectorId", "Name", "RequireEncryption" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
", "location": "uri", "locationName": "voiceConnectorId" }, "Name": { "shape": "VoiceConnectorName", "documentation": "The name of the Amazon Chime Voice Connector.
" }, "RequireEncryption": { "shape": "Boolean", "documentation": "When enabled, requires encryption for the Amazon Chime Voice Connector.
" } } }, "UpdateVoiceConnectorResponse": { "type": "structure", "members": { "VoiceConnector": { "shape": "VoiceConnector", "documentation": "The updated Amazon Chime Voice Connector details.
" } } }, "UriType": { "type": "string", "max": 4096 }, "UrlType": { "type": "string", "max": 4096 }, "User": { "type": "structure", "required": [ "UserId" ], "members": { "UserId": { "shape": "String", "documentation": "The user ID.
" }, "AccountId": { "shape": "String", "documentation": "The Amazon Chime account ID.
" }, "PrimaryEmail": { "shape": "EmailAddress", "documentation": "The primary email address of the user.
" }, "PrimaryProvisionedNumber": { "shape": "SensitiveString", "documentation": "The primary phone number associated with the user.
" }, "DisplayName": { "shape": "SensitiveString", "documentation": "The display name of the user.
" }, "LicenseType": { "shape": "License", "documentation": "The license type for the user.
" }, "UserType": { "shape": "UserType", "documentation": "The user type.
" }, "UserRegistrationStatus": { "shape": "RegistrationStatus", "documentation": "The user registration status.
" }, "UserInvitationStatus": { "shape": "InviteStatus", "documentation": "The user invite status.
" }, "RegisteredOn": { "shape": "Iso8601Timestamp", "documentation": "Date and time when the user is registered, in ISO 8601 format.
" }, "InvitedOn": { "shape": "Iso8601Timestamp", "documentation": "Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
" }, "AlexaForBusinessMetadata": { "shape": "AlexaForBusinessMetadata", "documentation": "The Alexa for Business metadata.
" }, "PersonalPIN": { "shape": "String", "documentation": "The user's personal meeting PIN.
" } }, "documentation": "The user on the Amazon Chime account.
" }, "UserEmailList": { "type": "list", "member": { "shape": "EmailAddress" }, "max": 50 }, "UserError": { "type": "structure", "members": { "UserId": { "shape": "NonEmptyString", "documentation": "The user ID for which the action failed.
" }, "ErrorCode": { "shape": "ErrorCode", "documentation": "The error code.
" }, "ErrorMessage": { "shape": "String", "documentation": "The error message.
" } }, "documentation": "The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
" }, "UserErrorList": { "type": "list", "member": { "shape": "UserError" } }, "UserId": { "type": "string", "max": 64, "min": 1, "pattern": "[A-Za-z0-9]([A-Za-z0-9\\:\\-\\_\\.\\@]{0,62}[A-Za-z0-9])?", "sensitive": true }, "UserIdList": { "type": "list", "member": { "shape": "NonEmptyString" }, "max": 50 }, "UserList": { "type": "list", "member": { "shape": "User" } }, "UserName": { "type": "string", "max": 100, "min": 1, "pattern": ".*\\S.*", "sensitive": true }, "UserSettings": { "type": "structure", "required": [ "Telephony" ], "members": { "Telephony": { "shape": "TelephonySettings", "documentation": "The telephony settings associated with the user.
" } }, "documentation": "Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.
" }, "UserType": { "type": "string", "enum": [ "PrivateUser", "SharedDevice" ] }, "ValidateE911AddressRequest": { "type": "structure", "required": [ "AwsAccountId", "StreetNumber", "StreetInfo", "City", "State", "Country", "PostalCode" ], "members": { "AwsAccountId": { "shape": "NonEmptyString", "documentation": "The AWS account ID.
" }, "StreetNumber": { "shape": "SensitiveNonEmptyString", "documentation": "The address street number, such as 200
or 2121
.
The address street information, such as 8th Avenue
.
The address city, such as Portland
.
The address state, such as ME
.
The address country, such as US
.
The address postal code, such as 04352
.
Number indicating the result of address validation. 0
means the address was perfect as is and successfully validated. 1
means the address was corrected. 2
means the address sent was not close enough and was not validated.
The ID that represents the address.
" }, "Address": { "shape": "Address", "documentation": "The validated address.
" }, "CandidateAddressList": { "shape": "CandidateAddressList", "documentation": "The list of address suggestions.
" } } }, "ValidationResult": { "type": "integer", "max": 2, "min": 0 }, "VideoArtifactsConfiguration": { "type": "structure", "required": [ "State" ], "members": { "State": { "shape": "ArtifactsState", "documentation": "Indicates whether the video artifact is enabled or disabled.
" }, "MuxType": { "shape": "VideoMuxType", "documentation": "The MUX type of the video artifact configuration object.
" } }, "documentation": "The video artifact configuration object.
" }, "VideoMuxType": { "type": "string", "enum": [ "VideoOnly" ] }, "VoiceConnector": { "type": "structure", "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
" }, "AwsRegion": { "shape": "VoiceConnectorAwsRegion", "documentation": " The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1
.
The name of the Amazon Chime Voice Connector.
" }, "OutboundHostName": { "shape": "String", "documentation": "The outbound host name for the Amazon Chime Voice Connector.
" }, "RequireEncryption": { "shape": "Boolean", "documentation": "Designates whether encryption is required for the Amazon Chime Voice Connector.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
" }, "VoiceConnectorArn": { "shape": "NonEmptyString", "documentation": "The ARN of the specified Amazon Chime Voice Connector.
" } }, "documentation": "The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.
" }, "VoiceConnectorAwsRegion": { "type": "string", "enum": [ "us-east-1", "us-west-2" ] }, "VoiceConnectorGroup": { "type": "structure", "members": { "VoiceConnectorGroupId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector group ID.
" }, "Name": { "shape": "VoiceConnectorGroupName", "documentation": "The name of the Amazon Chime Voice Connector group.
" }, "VoiceConnectorItems": { "shape": "VoiceConnectorItemList", "documentation": "The Amazon Chime Voice Connectors to which to route inbound calls.
" }, "CreatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
" }, "UpdatedTimestamp": { "shape": "Iso8601Timestamp", "documentation": "The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
" }, "VoiceConnectorGroupArn": { "shape": "NonEmptyString", "documentation": "The ARN of the specified Amazon Chime Voice Connector group.
" } }, "documentation": "The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
" }, "VoiceConnectorGroupList": { "type": "list", "member": { "shape": "VoiceConnectorGroup" } }, "VoiceConnectorGroupName": { "type": "string", "max": 256, "min": 1 }, "VoiceConnectorItem": { "type": "structure", "required": [ "VoiceConnectorId", "Priority" ], "members": { "VoiceConnectorId": { "shape": "NonEmptyString", "documentation": "The Amazon Chime Voice Connector ID.
" }, "Priority": { "shape": "VoiceConnectorItemPriority", "documentation": "The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
" } }, "documentation": "For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems
per Amazon Chime Voice Connector group.
The Amazon S3 bucket designated for call detail record storage.
", "box": true } }, "documentation": "The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.
" } }, "documentation": "Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the Amazon Chime SDK API reference, in the Amazon Chime SDK.
Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name chime
and REST endpoint https://service.chime.aws.amazon.com
.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.
", "deprecated": true, "deprecatedMessage": "This namespace has been deprecated" }