@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ChimeClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociatePhoneNumbersWithVoiceConnectorResponse |
associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest)
Deprecated.
Replaced by AssociatePhoneNumbersWithVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default AssociatePhoneNumbersWithVoiceConnectorResponse |
associatePhoneNumbersWithVoiceConnector(Consumer<AssociatePhoneNumbersWithVoiceConnectorRequest.Builder> associatePhoneNumbersWithVoiceConnectorRequest)
Deprecated.
Replaced by AssociatePhoneNumbersWithVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default AssociatePhoneNumbersWithVoiceConnectorGroupResponse |
associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest associatePhoneNumbersWithVoiceConnectorGroupRequest)
Deprecated.
Replaced by AssociatePhoneNumbersWithVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default AssociatePhoneNumbersWithVoiceConnectorGroupResponse |
associatePhoneNumbersWithVoiceConnectorGroup(Consumer<AssociatePhoneNumbersWithVoiceConnectorGroupRequest.Builder> associatePhoneNumbersWithVoiceConnectorGroupRequest)
Deprecated.
Replaced by AssociatePhoneNumbersWithVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default AssociatePhoneNumberWithUserResponse |
associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest)
Associates a phone number with the specified Amazon Chime user.
|
default AssociatePhoneNumberWithUserResponse |
associatePhoneNumberWithUser(Consumer<AssociatePhoneNumberWithUserRequest.Builder> associatePhoneNumberWithUserRequest)
Associates a phone number with the specified Amazon Chime user.
|
default AssociateSigninDelegateGroupsWithAccountResponse |
associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest)
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
|
default AssociateSigninDelegateGroupsWithAccountResponse |
associateSigninDelegateGroupsWithAccount(Consumer<AssociateSigninDelegateGroupsWithAccountRequest.Builder> associateSigninDelegateGroupsWithAccountRequest)
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
|
default BatchCreateAttendeeResponse |
batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest)
Deprecated.
Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings Namespace
|
default BatchCreateAttendeeResponse |
batchCreateAttendee(Consumer<BatchCreateAttendeeRequest.Builder> batchCreateAttendeeRequest)
Deprecated.
Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings Namespace
|
default BatchCreateChannelMembershipResponse |
batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest)
Deprecated.
Replaced by BatchCreateChannelMembership in the Amazon Chime SDK Messaging Namespace
|
default BatchCreateChannelMembershipResponse |
batchCreateChannelMembership(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest)
Deprecated.
Replaced by BatchCreateChannelMembership in the Amazon Chime SDK Messaging Namespace
|
default BatchCreateRoomMembershipResponse |
batchCreateRoomMembership(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest)
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.
|
default BatchCreateRoomMembershipResponse |
batchCreateRoomMembership(Consumer<BatchCreateRoomMembershipRequest.Builder> batchCreateRoomMembershipRequest)
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.
|
default BatchDeletePhoneNumberResponse |
batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest)
Moves phone numbers into the Deletion queue.
|
default BatchDeletePhoneNumberResponse |
batchDeletePhoneNumber(Consumer<BatchDeletePhoneNumberRequest.Builder> batchDeletePhoneNumberRequest)
Moves phone numbers into the Deletion queue.
|
default BatchSuspendUserResponse |
batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest)
Suspends up to 50 users from a
Team or EnterpriseLWA Amazon Chime account. |
default BatchSuspendUserResponse |
batchSuspendUser(Consumer<BatchSuspendUserRequest.Builder> batchSuspendUserRequest)
Suspends up to 50 users from a
Team or EnterpriseLWA Amazon Chime account. |
default BatchUnsuspendUserResponse |
batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest)
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA account. |
default BatchUnsuspendUserResponse |
batchUnsuspendUser(Consumer<BatchUnsuspendUserRequest.Builder> batchUnsuspendUserRequest)
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA account. |
default BatchUpdatePhoneNumberResponse |
batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest)
Updates phone number product types or calling names.
|
default BatchUpdatePhoneNumberResponse |
batchUpdatePhoneNumber(Consumer<BatchUpdatePhoneNumberRequest.Builder> batchUpdatePhoneNumberRequest)
Updates phone number product types or calling names.
|
default BatchUpdateUserResponse |
batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest)
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon
Chime account.
|
default BatchUpdateUserResponse |
batchUpdateUser(Consumer<BatchUpdateUserRequest.Builder> batchUpdateUserRequest)
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon
Chime account.
|
static ChimeClientBuilder |
builder()
Create a builder that can be used to configure and create a
ChimeClient. |
static ChimeClient |
create()
Create a
ChimeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAccountResponse |
createAccount(Consumer<CreateAccountRequest.Builder> createAccountRequest)
Creates an Amazon Chime account under the administrator's AWS account.
|
default CreateAccountResponse |
createAccount(CreateAccountRequest createAccountRequest)
Creates an Amazon Chime account under the administrator's AWS account.
|
default CreateAppInstanceResponse |
createAppInstance(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest)
Deprecated.
Replaced by CreateAppInstance in the Amazon Chime SDK Identity Namespace
|
default CreateAppInstanceResponse |
createAppInstance(CreateAppInstanceRequest createAppInstanceRequest)
Deprecated.
Replaced by CreateAppInstance in the Amazon Chime SDK Identity Namespace
|
default CreateAppInstanceAdminResponse |
createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest)
Deprecated.
Replaced by CreateAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
|
default CreateAppInstanceAdminResponse |
createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest)
Deprecated.
Replaced by CreateAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
|
default CreateAppInstanceUserResponse |
createAppInstanceUser(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest)
Deprecated.
Replaced by CreateAppInstanceUser in the Amazon Chime SDK Identity Namespace
|
default CreateAppInstanceUserResponse |
createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest)
Deprecated.
Replaced by CreateAppInstanceUser in the Amazon Chime SDK Identity Namespace
|
default CreateAttendeeResponse |
createAttendee(Consumer<CreateAttendeeRequest.Builder> createAttendeeRequest)
Deprecated.
Replaced by CreateAttendee in the Amazon Chime SDK Meetings Namespace
|
default CreateAttendeeResponse |
createAttendee(CreateAttendeeRequest createAttendeeRequest)
Deprecated.
Replaced by CreateAttendee in the Amazon Chime SDK Meetings Namespace
|
default CreateBotResponse |
createBot(Consumer<CreateBotRequest.Builder> createBotRequest)
Creates a bot for an Amazon Chime Enterprise account.
|
default CreateBotResponse |
createBot(CreateBotRequest createBotRequest)
Creates a bot for an Amazon Chime Enterprise account.
|
default CreateChannelResponse |
createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
Deprecated.
Replaced by CreateChannel in the Amazon Chime SDK Messaging Namespace
|
default CreateChannelResponse |
createChannel(CreateChannelRequest createChannelRequest)
Deprecated.
Replaced by CreateChannel in the Amazon Chime SDK Messaging Namespace
|
default CreateChannelBanResponse |
createChannelBan(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest)
Deprecated.
Replaced by CreateChannelBan in the Amazon Chime SDK Messaging Namespace
|
default CreateChannelBanResponse |
createChannelBan(CreateChannelBanRequest createChannelBanRequest)
Deprecated.
Replaced by CreateChannelBan in the Amazon Chime SDK Messaging Namespace
|
default CreateChannelMembershipResponse |
createChannelMembership(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest)
Deprecated.
Replaced by CreateChannelMembership in the Amazon Chime SDK Messaging Namespace
|
default CreateChannelMembershipResponse |
createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest)
Deprecated.
Replaced by CreateChannelMembership in the Amazon Chime SDK Messaging Namespace
|
default CreateChannelModeratorResponse |
createChannelModerator(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest)
Deprecated.
Replaced by CreateChannelModerator in the Amazon Chime SDK Messaging Namespace
|
default CreateChannelModeratorResponse |
createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest)
Deprecated.
Replaced by CreateChannelModerator in the Amazon Chime SDK Messaging Namespace
|
default CreateMediaCapturePipelineResponse |
createMediaCapturePipeline(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest)
Deprecated.
Replaced by CreateMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
|
default CreateMediaCapturePipelineResponse |
createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest)
Deprecated.
Replaced by CreateMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
|
default CreateMeetingResponse |
createMeeting(Consumer<CreateMeetingRequest.Builder> createMeetingRequest)
Deprecated.
Replaced by CreateMeeting in the Amazon Chime SDK Meetings Namespace
|
default CreateMeetingResponse |
createMeeting(CreateMeetingRequest createMeetingRequest)
Deprecated.
Replaced by CreateMeeting in the Amazon Chime SDK Meetings Namespace
|
default CreateMeetingDialOutResponse |
createMeetingDialOut(Consumer<CreateMeetingDialOutRequest.Builder> createMeetingDialOutRequest)
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.
|
default CreateMeetingDialOutResponse |
createMeetingDialOut(CreateMeetingDialOutRequest createMeetingDialOutRequest)
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.
|
default CreateMeetingWithAttendeesResponse |
createMeetingWithAttendees(Consumer<CreateMeetingWithAttendeesRequest.Builder> createMeetingWithAttendeesRequest)
Deprecated.
Replaced by CreateMeetingWithAttendees in the Amazon Chime SDK Meetings Namespace
|
default CreateMeetingWithAttendeesResponse |
createMeetingWithAttendees(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest)
Deprecated.
Replaced by CreateMeetingWithAttendees in the Amazon Chime SDK Meetings Namespace
|
default CreatePhoneNumberOrderResponse |
createPhoneNumberOrder(Consumer<CreatePhoneNumberOrderRequest.Builder> createPhoneNumberOrderRequest)
Creates an order for phone numbers to be provisioned.
|
default CreatePhoneNumberOrderResponse |
createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest)
Creates an order for phone numbers to be provisioned.
|
default CreateProxySessionResponse |
createProxySession(Consumer<CreateProxySessionRequest.Builder> createProxySessionRequest)
Deprecated.
Replaced by CreateProxySession in the Amazon Chime SDK Voice Namespace
|
default CreateProxySessionResponse |
createProxySession(CreateProxySessionRequest createProxySessionRequest)
Deprecated.
Replaced by CreateProxySession in the Amazon Chime SDK Voice Namespace
|
default CreateRoomResponse |
createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest)
Creates a chat room for the specified Amazon Chime Enterprise account.
|
default CreateRoomResponse |
createRoom(CreateRoomRequest createRoomRequest)
Creates a chat room for the specified Amazon Chime Enterprise account.
|
default CreateRoomMembershipResponse |
createRoomMembership(Consumer<CreateRoomMembershipRequest.Builder> createRoomMembershipRequest)
Adds a member to a chat room in an Amazon Chime Enterprise account.
|
default CreateRoomMembershipResponse |
createRoomMembership(CreateRoomMembershipRequest createRoomMembershipRequest)
Adds a member to a chat room in an Amazon Chime Enterprise account.
|
default CreateSipMediaApplicationResponse |
createSipMediaApplication(Consumer<CreateSipMediaApplicationRequest.Builder> createSipMediaApplicationRequest)
Deprecated.
Replaced by CreateSipMediaApplication in the Amazon Chime SDK Voice Namespace
|
default CreateSipMediaApplicationResponse |
createSipMediaApplication(CreateSipMediaApplicationRequest createSipMediaApplicationRequest)
Deprecated.
Replaced by CreateSipMediaApplication in the Amazon Chime SDK Voice Namespace
|
default CreateSipMediaApplicationCallResponse |
createSipMediaApplicationCall(Consumer<CreateSipMediaApplicationCallRequest.Builder> createSipMediaApplicationCallRequest)
Deprecated.
Replaced by CreateSipMediaApplicationCall in the Amazon Chime SDK Voice Namespace
|
default CreateSipMediaApplicationCallResponse |
createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest createSipMediaApplicationCallRequest)
Deprecated.
Replaced by CreateSipMediaApplicationCall in the Amazon Chime SDK Voice Namespace
|
default CreateSipRuleResponse |
createSipRule(Consumer<CreateSipRuleRequest.Builder> createSipRuleRequest)
Deprecated.
Replaced by CreateSipRule in the Amazon Chime SDK Voice Namespace
|
default CreateSipRuleResponse |
createSipRule(CreateSipRuleRequest createSipRuleRequest)
Deprecated.
Replaced by CreateSipRule in the Amazon Chime SDK Voice Namespace
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user under the specified Amazon Chime account.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates a user under the specified Amazon Chime account.
|
default CreateVoiceConnectorResponse |
createVoiceConnector(Consumer<CreateVoiceConnectorRequest.Builder> createVoiceConnectorRequest)
Deprecated.
Replaced by CreateVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default CreateVoiceConnectorResponse |
createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest)
Deprecated.
Replaced by CreateVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default CreateVoiceConnectorGroupResponse |
createVoiceConnectorGroup(Consumer<CreateVoiceConnectorGroupRequest.Builder> createVoiceConnectorGroupRequest)
Deprecated.
Replaced by CreateVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default CreateVoiceConnectorGroupResponse |
createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest createVoiceConnectorGroupRequest)
Deprecated.
Replaced by CreateVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default DeleteAccountResponse |
deleteAccount(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest)
Deletes the specified Amazon Chime account.
|
default DeleteAccountResponse |
deleteAccount(DeleteAccountRequest deleteAccountRequest)
Deletes the specified Amazon Chime account.
|
default DeleteAppInstanceResponse |
deleteAppInstance(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest)
Deprecated.
Replaced by DeleteAppInstance in the Amazon Chime SDK Identity Namespace
|
default DeleteAppInstanceResponse |
deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest)
Deprecated.
Replaced by DeleteAppInstance in the Amazon Chime SDK Identity Namespace
|
default DeleteAppInstanceAdminResponse |
deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest)
Deprecated.
Replaced by DeleteAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
|
default DeleteAppInstanceAdminResponse |
deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest)
Deprecated.
Replaced by DeleteAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
|
default DeleteAppInstanceStreamingConfigurationsResponse |
deleteAppInstanceStreamingConfigurations(Consumer<DeleteAppInstanceStreamingConfigurationsRequest.Builder> deleteAppInstanceStreamingConfigurationsRequest)
Deprecated.
Replaced by DeleteAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
|
default DeleteAppInstanceStreamingConfigurationsResponse |
deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest deleteAppInstanceStreamingConfigurationsRequest)
Deprecated.
Replaced by DeleteAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
|
default DeleteAppInstanceUserResponse |
deleteAppInstanceUser(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest)
Deprecated.
Replaced by DeleteAppInstanceUser in the Amazon Chime SDK Identity Namespace
|
default DeleteAppInstanceUserResponse |
deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest)
Deprecated.
Replaced by DeleteAppInstanceUser in the Amazon Chime SDK Identity Namespace
|
default DeleteAttendeeResponse |
deleteAttendee(Consumer<DeleteAttendeeRequest.Builder> deleteAttendeeRequest)
Deprecated.
Replaced by DeleteAttendee in the Amazon Chime SDK Meetings Namespace
|
default DeleteAttendeeResponse |
deleteAttendee(DeleteAttendeeRequest deleteAttendeeRequest)
Deprecated.
Replaced by DeleteAttendee in the Amazon Chime SDK Meetings Namespace
|
default DeleteChannelResponse |
deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
Deprecated.
Replaced by DeleteChannel in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelResponse |
deleteChannel(DeleteChannelRequest deleteChannelRequest)
Deprecated.
Replaced by DeleteChannel in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelBanResponse |
deleteChannelBan(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest)
Deprecated.
Replaced by DeleteChannelBan in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelBanResponse |
deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest)
Deprecated.
Replaced by DeleteChannelBan in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelMembershipResponse |
deleteChannelMembership(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest)
Deprecated.
Replaced by DeleteChannelMembership in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelMembershipResponse |
deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest)
Deprecated.
Replaced by DeleteChannelMembership in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelMessageResponse |
deleteChannelMessage(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest)
Deprecated.
Replaced by DeleteChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelMessageResponse |
deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest)
Deprecated.
Replaced by DeleteChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelModeratorResponse |
deleteChannelModerator(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest)
Deprecated.
Replaced by DeleteChannelModerator in the Amazon Chime SDK Messaging Namespace
|
default DeleteChannelModeratorResponse |
deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest)
Deprecated.
Replaced by DeleteChannelModerator in the Amazon Chime SDK Messaging Namespace
|
default DeleteEventsConfigurationResponse |
deleteEventsConfiguration(Consumer<DeleteEventsConfigurationRequest.Builder> deleteEventsConfigurationRequest)
Deletes the events configuration that allows a bot to receive outgoing events.
|
default DeleteEventsConfigurationResponse |
deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest)
Deletes the events configuration that allows a bot to receive outgoing events.
|
default DeleteMediaCapturePipelineResponse |
deleteMediaCapturePipeline(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest)
Deprecated.
Replaced by DeleteMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
|
default DeleteMediaCapturePipelineResponse |
deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest)
Deprecated.
Replaced by DeleteMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
|
default DeleteMeetingResponse |
deleteMeeting(Consumer<DeleteMeetingRequest.Builder> deleteMeetingRequest)
Deprecated.
Replaced by DeleteMeeting in the Amazon Chime SDK Meetings Namespace
|
default DeleteMeetingResponse |
deleteMeeting(DeleteMeetingRequest deleteMeetingRequest)
Deprecated.
Replaced by DeleteMeeting in the Amazon Chime SDK Meetings Namespace
|
default DeletePhoneNumberResponse |
deletePhoneNumber(Consumer<DeletePhoneNumberRequest.Builder> deletePhoneNumberRequest)
Moves the specified phone number into the Deletion queue.
|
default DeletePhoneNumberResponse |
deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest)
Moves the specified phone number into the Deletion queue.
|
default DeleteProxySessionResponse |
deleteProxySession(Consumer<DeleteProxySessionRequest.Builder> deleteProxySessionRequest)
Deprecated.
Replaced by DeleteProxySession in the Amazon Chime SDK Voice Namespace
|
default DeleteProxySessionResponse |
deleteProxySession(DeleteProxySessionRequest deleteProxySessionRequest)
Deprecated.
Replaced by DeleteProxySession in the Amazon Chime SDK Voice Namespace
|
default DeleteRoomResponse |
deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest)
Deletes a chat room in an Amazon Chime Enterprise account.
|
default DeleteRoomResponse |
deleteRoom(DeleteRoomRequest deleteRoomRequest)
Deletes a chat room in an Amazon Chime Enterprise account.
|
default DeleteRoomMembershipResponse |
deleteRoomMembership(Consumer<DeleteRoomMembershipRequest.Builder> deleteRoomMembershipRequest)
Removes a member from a chat room in an Amazon Chime Enterprise account.
|
default DeleteRoomMembershipResponse |
deleteRoomMembership(DeleteRoomMembershipRequest deleteRoomMembershipRequest)
Removes a member from a chat room in an Amazon Chime Enterprise account.
|
default DeleteSipMediaApplicationResponse |
deleteSipMediaApplication(Consumer<DeleteSipMediaApplicationRequest.Builder> deleteSipMediaApplicationRequest)
Deprecated.
Replaced by DeleteSipMediaApplication in the Amazon Chime SDK Voice Namespace
|
default DeleteSipMediaApplicationResponse |
deleteSipMediaApplication(DeleteSipMediaApplicationRequest deleteSipMediaApplicationRequest)
Deprecated.
Replaced by DeleteSipMediaApplication in the Amazon Chime SDK Voice Namespace
|
default DeleteSipRuleResponse |
deleteSipRule(Consumer<DeleteSipRuleRequest.Builder> deleteSipRuleRequest)
Deprecated.
Replaced by DeleteSipRule in the Amazon Chime SDK Voice Namespace
|
default DeleteSipRuleResponse |
deleteSipRule(DeleteSipRuleRequest deleteSipRuleRequest)
Deprecated.
Replaced by DeleteSipRule in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorResponse |
deleteVoiceConnector(Consumer<DeleteVoiceConnectorRequest.Builder> deleteVoiceConnectorRequest)
Deprecated.
Replaced by DeleteVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorResponse |
deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest)
Deprecated.
Replaced by DeleteVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorEmergencyCallingConfigurationResponse |
deleteVoiceConnectorEmergencyCallingConfiguration(Consumer<DeleteVoiceConnectorEmergencyCallingConfigurationRequest.Builder> deleteVoiceConnectorEmergencyCallingConfigurationRequest)
Deprecated.
Replaced by DeleteVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorEmergencyCallingConfigurationResponse |
deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest deleteVoiceConnectorEmergencyCallingConfigurationRequest)
Deprecated.
Replaced by DeleteVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorGroupResponse |
deleteVoiceConnectorGroup(Consumer<DeleteVoiceConnectorGroupRequest.Builder> deleteVoiceConnectorGroupRequest)
Deprecated.
Replaced by DeleteVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorGroupResponse |
deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest deleteVoiceConnectorGroupRequest)
Deprecated.
Replaced by DeleteVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorOriginationResponse |
deleteVoiceConnectorOrigination(Consumer<DeleteVoiceConnectorOriginationRequest.Builder> deleteVoiceConnectorOriginationRequest)
Deprecated.
Replaced by DeleteVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorOriginationResponse |
deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest)
Deprecated.
Replaced by DeleteVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorProxyResponse |
deleteVoiceConnectorProxy(Consumer<DeleteVoiceConnectorProxyRequest.Builder> deleteVoiceConnectorProxyRequest)
Deprecated.
Replaced by DeleteVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorProxyResponse |
deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest deleteVoiceConnectorProxyRequest)
Deprecated.
Replaced by DeleteVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorStreamingConfigurationResponse |
deleteVoiceConnectorStreamingConfiguration(Consumer<DeleteVoiceConnectorStreamingConfigurationRequest.Builder> deleteVoiceConnectorStreamingConfigurationRequest)
Deprecated.
Replaced by DeleteVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorStreamingConfigurationResponse |
deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest deleteVoiceConnectorStreamingConfigurationRequest)
Deprecated.
Replaced by DeleteVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorTerminationResponse |
deleteVoiceConnectorTermination(Consumer<DeleteVoiceConnectorTerminationRequest.Builder> deleteVoiceConnectorTerminationRequest)
Deprecated.
Replaced by DeleteVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorTerminationResponse |
deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest)
Deprecated.
Replaced by DeleteVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorTerminationCredentialsResponse |
deleteVoiceConnectorTerminationCredentials(Consumer<DeleteVoiceConnectorTerminationCredentialsRequest.Builder> deleteVoiceConnectorTerminationCredentialsRequest)
Deprecated.
Replaced by DeleteVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
|
default DeleteVoiceConnectorTerminationCredentialsResponse |
deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest)
Deprecated.
Replaced by DeleteVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
|
default DescribeAppInstanceResponse |
describeAppInstance(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest)
Deprecated.
Replaced by DescribeAppInstance in the Amazon Chime SDK Identity Namespace
|
default DescribeAppInstanceResponse |
describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest)
Deprecated.
Replaced by DescribeAppInstance in the Amazon Chime SDK Identity Namespace
|
default DescribeAppInstanceAdminResponse |
describeAppInstanceAdmin(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest)
Deprecated.
Replaced by DescribeAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
|
default DescribeAppInstanceAdminResponse |
describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest)
Deprecated.
Replaced by DescribeAppInstanceAdmin in the Amazon Chime SDK Identity Namespace
|
default DescribeAppInstanceUserResponse |
describeAppInstanceUser(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest)
Deprecated.
Replaced by DescribeAppInstanceUser in the Amazon Chime SDK Identity Namespace
|
default DescribeAppInstanceUserResponse |
describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest)
Deprecated.
Replaced by DescribeAppInstanceUser in the Amazon Chime SDK Identity Namespace
|
default DescribeChannelResponse |
describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest)
Deprecated.
Replaced by DescribeChannel in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelResponse |
describeChannel(DescribeChannelRequest describeChannelRequest)
Deprecated.
Replaced by DescribeChannel in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelBanResponse |
describeChannelBan(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest)
Deprecated.
Replaced by DescribeChannelBan in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelBanResponse |
describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest)
Deprecated.
Replaced by DescribeChannelBan in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelMembershipResponse |
describeChannelMembership(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest)
Deprecated.
Replaced by DescribeChannelMembership in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelMembershipResponse |
describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest)
Deprecated.
Replaced by DescribeChannelMembership in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelMembershipForAppInstanceUserResponse |
describeChannelMembershipForAppInstanceUser(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest)
Deprecated.
Replaced by DescribeChannelMembershipForAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelMembershipForAppInstanceUserResponse |
describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest)
Deprecated.
Replaced by DescribeChannelMembershipForAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelModeratedByAppInstanceUserResponse |
describeChannelModeratedByAppInstanceUser(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest)
Deprecated.
Replaced by DescribeChannelModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelModeratedByAppInstanceUserResponse |
describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest)
Deprecated.
Replaced by DescribeChannelModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelModeratorResponse |
describeChannelModerator(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest)
Deprecated.
Replaced by DescribeChannelModerator in the Amazon Chime SDK Messaging Namespace
|
default DescribeChannelModeratorResponse |
describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest)
Deprecated.
Replaced by DescribeChannelModerator in the Amazon Chime SDK Messaging Namespace
|
default DisassociatePhoneNumberFromUserResponse |
disassociatePhoneNumberFromUser(Consumer<DisassociatePhoneNumberFromUserRequest.Builder> disassociatePhoneNumberFromUserRequest)
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
|
default DisassociatePhoneNumberFromUserResponse |
disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest)
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
|
default DisassociatePhoneNumbersFromVoiceConnectorResponse |
disassociatePhoneNumbersFromVoiceConnector(Consumer<DisassociatePhoneNumbersFromVoiceConnectorRequest.Builder> disassociatePhoneNumbersFromVoiceConnectorRequest)
Deprecated.
Replaced by DisassociatePhoneNumbersFromVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default DisassociatePhoneNumbersFromVoiceConnectorResponse |
disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest)
Deprecated.
Replaced by DisassociatePhoneNumbersFromVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default DisassociatePhoneNumbersFromVoiceConnectorGroupResponse |
disassociatePhoneNumbersFromVoiceConnectorGroup(Consumer<DisassociatePhoneNumbersFromVoiceConnectorGroupRequest.Builder> disassociatePhoneNumbersFromVoiceConnectorGroupRequest)
Deprecated.
Replaced by DisassociatePhoneNumbersFromVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default DisassociatePhoneNumbersFromVoiceConnectorGroupResponse |
disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest disassociatePhoneNumbersFromVoiceConnectorGroupRequest)
Deprecated.
Replaced by DisassociatePhoneNumbersFromVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default DisassociateSigninDelegateGroupsFromAccountResponse |
disassociateSigninDelegateGroupsFromAccount(Consumer<DisassociateSigninDelegateGroupsFromAccountRequest.Builder> disassociateSigninDelegateGroupsFromAccountRequest)
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
|
default DisassociateSigninDelegateGroupsFromAccountResponse |
disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest)
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
|
default GetAccountResponse |
getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
|
default GetAccountResponse |
getAccount(GetAccountRequest getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
|
default GetAccountSettingsResponse |
getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout
settings.
|
default GetAccountSettingsResponse |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout
settings.
|
default GetAppInstanceRetentionSettingsResponse |
getAppInstanceRetentionSettings(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest)
Deprecated.
Replaced by GetAppInstanceRetentionSettings in the Amazon Chime SDK Identity Namespace
|
default GetAppInstanceRetentionSettingsResponse |
getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest)
Deprecated.
Replaced by GetAppInstanceRetentionSettings in the Amazon Chime SDK Identity Namespace
|
default GetAppInstanceStreamingConfigurationsResponse |
getAppInstanceStreamingConfigurations(Consumer<GetAppInstanceStreamingConfigurationsRequest.Builder> getAppInstanceStreamingConfigurationsRequest)
Deprecated.
Replaced by GetAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
|
default GetAppInstanceStreamingConfigurationsResponse |
getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest getAppInstanceStreamingConfigurationsRequest)
Deprecated.
Replaced by GetAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
|
default GetAttendeeResponse |
getAttendee(Consumer<GetAttendeeRequest.Builder> getAttendeeRequest)
Deprecated.
Replaced by GetAttendee in the Amazon Chime SDK Meetings Namespace
|
default GetAttendeeResponse |
getAttendee(GetAttendeeRequest getAttendeeRequest)
Deprecated.
Replaced by GetAttendee in the Amazon Chime SDK Meetings Namespace
|
default GetBotResponse |
getBot(Consumer<GetBotRequest.Builder> getBotRequest)
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
|
default GetBotResponse |
getBot(GetBotRequest getBotRequest)
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
|
default GetChannelMessageResponse |
getChannelMessage(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest)
Deprecated.
Replaced by GetChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default GetChannelMessageResponse |
getChannelMessage(GetChannelMessageRequest getChannelMessageRequest)
Deprecated.
Replaced by GetChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default GetEventsConfigurationResponse |
getEventsConfiguration(Consumer<GetEventsConfigurationRequest.Builder> getEventsConfigurationRequest)
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint
or Lambda function ARN.
|
default GetEventsConfigurationResponse |
getEventsConfiguration(GetEventsConfigurationRequest getEventsConfigurationRequest)
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint
or Lambda function ARN.
|
default GetGlobalSettingsResponse |
getGlobalSettings(Consumer<GetGlobalSettingsRequest.Builder> getGlobalSettingsRequest)
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon
Chime Voice Connector settings.
|
default GetGlobalSettingsResponse |
getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest)
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon
Chime Voice Connector settings.
|
default GetMediaCapturePipelineResponse |
getMediaCapturePipeline(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest)
Deprecated.
Replaced by GetMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
|
default GetMediaCapturePipelineResponse |
getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest)
Deprecated.
Replaced by GetMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespace
|
default GetMeetingResponse |
getMeeting(Consumer<GetMeetingRequest.Builder> getMeetingRequest)
Deprecated.
Replaced by GetMeeting in the Amazon Chime SDK Meetings Namespace
|
default GetMeetingResponse |
getMeeting(GetMeetingRequest getMeetingRequest)
Deprecated.
Replaced by GetMeeting in the Amazon Chime SDK Meetings Namespace
|
default GetMessagingSessionEndpointResponse |
getMessagingSessionEndpoint(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest)
Deprecated.
Replaced by GetMessagingSessionEndpoint in the Amazon Chime SDK Messaging Namespace
|
default GetMessagingSessionEndpointResponse |
getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest)
Deprecated.
Replaced by GetMessagingSessionEndpoint in the Amazon Chime SDK Messaging Namespace
|
default GetPhoneNumberResponse |
getPhoneNumber(Consumer<GetPhoneNumberRequest.Builder> getPhoneNumberRequest)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
|
default GetPhoneNumberResponse |
getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
|
default GetPhoneNumberOrderResponse |
getPhoneNumberOrder(Consumer<GetPhoneNumberOrderRequest.Builder> getPhoneNumberOrderRequest)
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.
|
default GetPhoneNumberOrderResponse |
getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest)
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.
|
default GetPhoneNumberSettingsResponse |
getPhoneNumberSettings(Consumer<GetPhoneNumberSettingsRequest.Builder> getPhoneNumberSettingsRequest)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling
name.
|
default GetPhoneNumberSettingsResponse |
getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling
name.
|
default GetProxySessionResponse |
getProxySession(Consumer<GetProxySessionRequest.Builder> getProxySessionRequest)
Deprecated.
Replaced by GetProxySession in the Amazon Chime SDK Voice Namespace
|
default GetProxySessionResponse |
getProxySession(GetProxySessionRequest getProxySessionRequest)
Deprecated.
Replaced by GetProxySession in the Amazon Chime SDK Voice Namespace
|
default GetRetentionSettingsResponse |
getRetentionSettings(Consumer<GetRetentionSettingsRequest.Builder> getRetentionSettingsRequest)
Gets the retention settings for the specified Amazon Chime Enterprise account.
|
default GetRetentionSettingsResponse |
getRetentionSettings(GetRetentionSettingsRequest getRetentionSettingsRequest)
Gets the retention settings for the specified Amazon Chime Enterprise account.
|
default GetRoomResponse |
getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest)
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
|
default GetRoomResponse |
getRoom(GetRoomRequest getRoomRequest)
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
|
default GetSipMediaApplicationResponse |
getSipMediaApplication(Consumer<GetSipMediaApplicationRequest.Builder> getSipMediaApplicationRequest)
Deprecated.
Replaced by GetSipMediaApplication in the Amazon Chime SDK Voice Namespace
|
default GetSipMediaApplicationResponse |
getSipMediaApplication(GetSipMediaApplicationRequest getSipMediaApplicationRequest)
Deprecated.
Replaced by GetSipMediaApplication in the Amazon Chime SDK Voice Namespace
|
default GetSipMediaApplicationLoggingConfigurationResponse |
getSipMediaApplicationLoggingConfiguration(Consumer<GetSipMediaApplicationLoggingConfigurationRequest.Builder> getSipMediaApplicationLoggingConfigurationRequest)
Deprecated.
Replaced by GetSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice Namespace
|
default GetSipMediaApplicationLoggingConfigurationResponse |
getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest getSipMediaApplicationLoggingConfigurationRequest)
Deprecated.
Replaced by GetSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice Namespace
|
default GetSipRuleResponse |
getSipRule(Consumer<GetSipRuleRequest.Builder> getSipRuleRequest)
Deprecated.
Replaced by GetSipRule in the Amazon Chime SDK Voice Namespace
|
default GetSipRuleResponse |
getSipRule(GetSipRuleRequest getSipRuleRequest)
Deprecated.
Replaced by GetSipRule in the Amazon Chime SDK Voice Namespace
|
default GetUserResponse |
getUser(Consumer<GetUserRequest.Builder> getUserRequest)
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting
PIN.
|
default GetUserResponse |
getUser(GetUserRequest getUserRequest)
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting
PIN.
|
default GetUserSettingsResponse |
getUserSettings(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest)
Retrieves settings for the specified user ID, such as any associated phone number settings.
|
default GetUserSettingsResponse |
getUserSettings(GetUserSettingsRequest getUserSettingsRequest)
Retrieves settings for the specified user ID, such as any associated phone number settings.
|
default GetVoiceConnectorResponse |
getVoiceConnector(Consumer<GetVoiceConnectorRequest.Builder> getVoiceConnectorRequest)
Deprecated.
Replaced by GetVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorResponse |
getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest)
Deprecated.
Replaced by GetVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorEmergencyCallingConfigurationResponse |
getVoiceConnectorEmergencyCallingConfiguration(Consumer<GetVoiceConnectorEmergencyCallingConfigurationRequest.Builder> getVoiceConnectorEmergencyCallingConfigurationRequest)
Deprecated.
Replaced by GetVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorEmergencyCallingConfigurationResponse |
getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest getVoiceConnectorEmergencyCallingConfigurationRequest)
Deprecated.
Replaced by GetVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorGroupResponse |
getVoiceConnectorGroup(Consumer<GetVoiceConnectorGroupRequest.Builder> getVoiceConnectorGroupRequest)
Deprecated.
Replaced by GetVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorGroupResponse |
getVoiceConnectorGroup(GetVoiceConnectorGroupRequest getVoiceConnectorGroupRequest)
Deprecated.
Replaced by GetVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorLoggingConfigurationResponse |
getVoiceConnectorLoggingConfiguration(Consumer<GetVoiceConnectorLoggingConfigurationRequest.Builder> getVoiceConnectorLoggingConfigurationRequest)
Deprecated.
Replaced by GetVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorLoggingConfigurationResponse |
getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest getVoiceConnectorLoggingConfigurationRequest)
Deprecated.
Replaced by GetVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorOriginationResponse |
getVoiceConnectorOrigination(Consumer<GetVoiceConnectorOriginationRequest.Builder> getVoiceConnectorOriginationRequest)
Deprecated.
Replaced by GetVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorOriginationResponse |
getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest)
Deprecated.
Replaced by GetVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorProxyResponse |
getVoiceConnectorProxy(Consumer<GetVoiceConnectorProxyRequest.Builder> getVoiceConnectorProxyRequest)
Deprecated.
Replaced by GetVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorProxyResponse |
getVoiceConnectorProxy(GetVoiceConnectorProxyRequest getVoiceConnectorProxyRequest)
Deprecated.
Replaced by GetVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorStreamingConfigurationResponse |
getVoiceConnectorStreamingConfiguration(Consumer<GetVoiceConnectorStreamingConfigurationRequest.Builder> getVoiceConnectorStreamingConfigurationRequest)
Deprecated.
Replaced by GetVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorStreamingConfigurationResponse |
getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest getVoiceConnectorStreamingConfigurationRequest)
Deprecated.
Replaced by GetVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorTerminationResponse |
getVoiceConnectorTermination(Consumer<GetVoiceConnectorTerminationRequest.Builder> getVoiceConnectorTerminationRequest)
Deprecated.
Replaced by GetVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorTerminationResponse |
getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest)
Deprecated.
Replaced by GetVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorTerminationHealthResponse |
getVoiceConnectorTerminationHealth(Consumer<GetVoiceConnectorTerminationHealthRequest.Builder> getVoiceConnectorTerminationHealthRequest)
Deprecated.
Replaced by GetVoiceConnectorTerminationHealth in the Amazon Chime SDK Voice Namespace
|
default GetVoiceConnectorTerminationHealthResponse |
getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest)
Deprecated.
Replaced by GetVoiceConnectorTerminationHealth in the Amazon Chime SDK Voice Namespace
|
default InviteUsersResponse |
inviteUsers(Consumer<InviteUsersRequest.Builder> inviteUsersRequest)
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
Team account. |
default InviteUsersResponse |
inviteUsers(InviteUsersRequest inviteUsersRequest)
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
Team account. |
default ListAccountsResponse |
listAccounts()
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAccountsResponse |
listAccounts(Consumer<ListAccountsRequest.Builder> listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAccountsResponse |
listAccounts(ListAccountsRequest listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAccountsIterable |
listAccountsPaginator()
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAccountsIterable |
listAccountsPaginator(Consumer<ListAccountsRequest.Builder> listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAccountsIterable |
listAccountsPaginator(ListAccountsRequest listAccountsRequest)
Lists the Amazon Chime accounts under the administrator's AWS account.
|
default ListAppInstanceAdminsResponse |
listAppInstanceAdmins(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest)
Deprecated.
Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity Namespace
|
default ListAppInstanceAdminsResponse |
listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)
Deprecated.
Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity Namespace
|
default ListAppInstanceAdminsIterable |
listAppInstanceAdminsPaginator(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest)
Deprecated.
Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity Namespace
|
default ListAppInstanceAdminsIterable |
listAppInstanceAdminsPaginator(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)
Deprecated.
Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity Namespace
|
default ListAppInstancesResponse |
listAppInstances(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest)
Deprecated.
Replaced by ListAppInstances in the Amazon Chime SDK Identity Namespace
|
default ListAppInstancesResponse |
listAppInstances(ListAppInstancesRequest listAppInstancesRequest)
Deprecated.
Replaced by ListAppInstances in the Amazon Chime SDK Identity Namespace
|
default ListAppInstancesIterable |
listAppInstancesPaginator(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest)
Deprecated.
Replaced by ListAppInstances in the Amazon Chime SDK Identity Namespace
|
default ListAppInstancesIterable |
listAppInstancesPaginator(ListAppInstancesRequest listAppInstancesRequest)
Deprecated.
Replaced by ListAppInstances in the Amazon Chime SDK Identity Namespace
|
default ListAppInstanceUsersResponse |
listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest)
Deprecated.
Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity Namespace
|
default ListAppInstanceUsersResponse |
listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest)
Deprecated.
Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity Namespace
|
default ListAppInstanceUsersIterable |
listAppInstanceUsersPaginator(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest)
Deprecated.
Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity Namespace
|
default ListAppInstanceUsersIterable |
listAppInstanceUsersPaginator(ListAppInstanceUsersRequest listAppInstanceUsersRequest)
Deprecated.
Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity Namespace
|
default ListAttendeesResponse |
listAttendees(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest)
Deprecated.
Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespace
|
default ListAttendeesResponse |
listAttendees(ListAttendeesRequest listAttendeesRequest)
Deprecated.
Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespace
|
default ListAttendeesIterable |
listAttendeesPaginator(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest)
Deprecated.
Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespace
|
default ListAttendeesIterable |
listAttendeesPaginator(ListAttendeesRequest listAttendeesRequest)
Deprecated.
Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespace
|
default ListAttendeeTagsResponse |
listAttendeeTags(Consumer<ListAttendeeTagsRequest.Builder> listAttendeeTagsRequest)
Deprecated.
Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application
to remove calls to this API.
|
default ListAttendeeTagsResponse |
listAttendeeTags(ListAttendeeTagsRequest listAttendeeTagsRequest)
Deprecated.
Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application
to remove calls to this API.
|
default ListBotsResponse |
listBots(Consumer<ListBotsRequest.Builder> listBotsRequest)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
|
default ListBotsResponse |
listBots(ListBotsRequest listBotsRequest)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
|
default ListBotsIterable |
listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
|
default ListBotsIterable |
listBotsPaginator(ListBotsRequest listBotsRequest)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
|
default ListChannelBansResponse |
listChannelBans(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest)
Deprecated.
Replaced by ListChannelBans in the Amazon Chime SDK Messaging Namespace
|
default ListChannelBansResponse |
listChannelBans(ListChannelBansRequest listChannelBansRequest)
Deprecated.
Replaced by ListChannelBans in the Amazon Chime SDK Messaging Namespace
|
default ListChannelBansIterable |
listChannelBansPaginator(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest)
Deprecated.
Replaced by ListChannelBans in the Amazon Chime SDK Messaging Namespace
|
default ListChannelBansIterable |
listChannelBansPaginator(ListChannelBansRequest listChannelBansRequest)
Deprecated.
Replaced by ListChannelBans in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMembershipsResponse |
listChannelMemberships(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest)
Deprecated.
Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMembershipsResponse |
listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest)
Deprecated.
Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMembershipsForAppInstanceUserResponse |
listChannelMembershipsForAppInstanceUser(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest)
Deprecated.
Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMembershipsForAppInstanceUserResponse |
listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
Deprecated.
Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMembershipsForAppInstanceUserIterable |
listChannelMembershipsForAppInstanceUserPaginator(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest)
Deprecated.
Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMembershipsForAppInstanceUserIterable |
listChannelMembershipsForAppInstanceUserPaginator(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
Deprecated.
Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMembershipsIterable |
listChannelMembershipsPaginator(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest)
Deprecated.
Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMembershipsIterable |
listChannelMembershipsPaginator(ListChannelMembershipsRequest listChannelMembershipsRequest)
Deprecated.
Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMessagesResponse |
listChannelMessages(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest)
Deprecated.
Replaced by ListChannelMessages in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMessagesResponse |
listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest)
Deprecated.
Replaced by ListChannelMessages in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMessagesIterable |
listChannelMessagesPaginator(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest)
Deprecated.
Replaced by ListChannelMessages in the Amazon Chime SDK Messaging Namespace
|
default ListChannelMessagesIterable |
listChannelMessagesPaginator(ListChannelMessagesRequest listChannelMessagesRequest)
Deprecated.
Replaced by ListChannelMessages in the Amazon Chime SDK Messaging Namespace
|
default ListChannelModeratorsResponse |
listChannelModerators(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest)
Deprecated.
Replaced by ListChannelModerators in the Amazon Chime SDK Messaging Namespace
|
default ListChannelModeratorsResponse |
listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest)
Deprecated.
Replaced by ListChannelModerators in the Amazon Chime SDK Messaging Namespace
|
default ListChannelModeratorsIterable |
listChannelModeratorsPaginator(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest)
Deprecated.
Replaced by ListChannelModerators in the Amazon Chime SDK Messaging Namespace
|
default ListChannelModeratorsIterable |
listChannelModeratorsPaginator(ListChannelModeratorsRequest listChannelModeratorsRequest)
Deprecated.
Replaced by ListChannelModerators in the Amazon Chime SDK Messaging Namespace
|
default ListChannelsResponse |
listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Deprecated.
Replaced by ListChannels in the Amazon Chime SDK Messaging Namespace
|
default ListChannelsResponse |
listChannels(ListChannelsRequest listChannelsRequest)
Deprecated.
Replaced by ListChannels in the Amazon Chime SDK Messaging Namespace
|
default ListChannelsModeratedByAppInstanceUserResponse |
listChannelsModeratedByAppInstanceUser(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest)
Deprecated.
Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default ListChannelsModeratedByAppInstanceUserResponse |
listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
Deprecated.
Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default ListChannelsModeratedByAppInstanceUserIterable |
listChannelsModeratedByAppInstanceUserPaginator(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest)
Deprecated.
Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default ListChannelsModeratedByAppInstanceUserIterable |
listChannelsModeratedByAppInstanceUserPaginator(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
Deprecated.
Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespace
|
default ListChannelsIterable |
listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Deprecated.
Replaced by ListChannels in the Amazon Chime SDK Messaging Namespace
|
default ListChannelsIterable |
listChannelsPaginator(ListChannelsRequest listChannelsRequest)
Deprecated.
Replaced by ListChannels in the Amazon Chime SDK Messaging Namespace
|
default ListMediaCapturePipelinesResponse |
listMediaCapturePipelines(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest)
Deprecated.
Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines Namespace
|
default ListMediaCapturePipelinesResponse |
listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest)
Deprecated.
Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines Namespace
|
default ListMediaCapturePipelinesIterable |
listMediaCapturePipelinesPaginator(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest)
Deprecated.
Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines Namespace
|
default ListMediaCapturePipelinesIterable |
listMediaCapturePipelinesPaginator(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest)
Deprecated.
Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines Namespace
|
default ListMeetingsResponse |
listMeetings(Consumer<ListMeetingsRequest.Builder> listMeetingsRequest)
Deprecated.
ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to
remove calls to this API.
|
default ListMeetingsResponse |
listMeetings(ListMeetingsRequest listMeetingsRequest)
Deprecated.
ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to
remove calls to this API.
|
default ListMeetingsIterable |
listMeetingsPaginator(Consumer<ListMeetingsRequest.Builder> listMeetingsRequest)
Deprecated.
ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to
remove calls to this API.
|
default ListMeetingsIterable |
listMeetingsPaginator(ListMeetingsRequest listMeetingsRequest)
Deprecated.
ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to
remove calls to this API.
|
default ListMeetingTagsResponse |
listMeetingTags(Consumer<ListMeetingTagsRequest.Builder> listMeetingTagsRequest)
Deprecated.
Use ListTagsForResource in the Amazon Chime SDK Meetings Namespace.
|
default ListMeetingTagsResponse |
listMeetingTags(ListMeetingTagsRequest listMeetingTagsRequest)
Deprecated.
Use ListTagsForResource in the Amazon Chime SDK Meetings Namespace.
|
default ListPhoneNumberOrdersResponse |
listPhoneNumberOrders(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest)
Lists the phone number orders for the administrator's Amazon Chime account.
|
default ListPhoneNumberOrdersResponse |
listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)
Lists the phone number orders for the administrator's Amazon Chime account.
|
default ListPhoneNumberOrdersIterable |
listPhoneNumberOrdersPaginator(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest)
Lists the phone number orders for the administrator's Amazon Chime account.
|
default ListPhoneNumberOrdersIterable |
listPhoneNumberOrdersPaginator(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)
Lists the phone number orders for the administrator's Amazon Chime account.
|
default ListPhoneNumbersResponse |
listPhoneNumbers(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector,
or Amazon Chime Voice Connector group.
|
default ListPhoneNumbersResponse |
listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector,
or Amazon Chime Voice Connector group.
|
default ListPhoneNumbersIterable |
listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector,
or Amazon Chime Voice Connector group.
|
default ListPhoneNumbersIterable |
listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector,
or Amazon Chime Voice Connector group.
|
default ListProxySessionsResponse |
listProxySessions(Consumer<ListProxySessionsRequest.Builder> listProxySessionsRequest)
Deprecated.
Replaced by ListProxySessions in the Amazon Chime SDK Voice Namespace
|
default ListProxySessionsResponse |
listProxySessions(ListProxySessionsRequest listProxySessionsRequest)
Deprecated.
Replaced by ListProxySessions in the Amazon Chime SDK Voice Namespace
|
default ListProxySessionsIterable |
listProxySessionsPaginator(Consumer<ListProxySessionsRequest.Builder> listProxySessionsRequest)
Deprecated.
Replaced by ListProxySessions in the Amazon Chime SDK Voice Namespace
|
default ListProxySessionsIterable |
listProxySessionsPaginator(ListProxySessionsRequest listProxySessionsRequest)
Deprecated.
Replaced by ListProxySessions in the Amazon Chime SDK Voice Namespace
|
default ListRoomMembershipsResponse |
listRoomMemberships(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest)
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members'
IDs, email addresses, and names.
|
default ListRoomMembershipsResponse |
listRoomMemberships(ListRoomMembershipsRequest listRoomMembershipsRequest)
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members'
IDs, email addresses, and names.
|
default ListRoomMembershipsIterable |
listRoomMembershipsPaginator(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest)
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members'
IDs, email addresses, and names.
|
default ListRoomMembershipsIterable |
listRoomMembershipsPaginator(ListRoomMembershipsRequest listRoomMembershipsRequest)
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members'
IDs, email addresses, and names.
|
default ListRoomsResponse |
listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest)
Lists the room details for the specified Amazon Chime Enterprise account.
|
default ListRoomsResponse |
listRooms(ListRoomsRequest listRoomsRequest)
Lists the room details for the specified Amazon Chime Enterprise account.
|
default ListRoomsIterable |
listRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest)
Lists the room details for the specified Amazon Chime Enterprise account.
|
default ListRoomsIterable |
listRoomsPaginator(ListRoomsRequest listRoomsRequest)
Lists the room details for the specified Amazon Chime Enterprise account.
|
default ListSipMediaApplicationsResponse |
listSipMediaApplications(Consumer<ListSipMediaApplicationsRequest.Builder> listSipMediaApplicationsRequest)
Deprecated.
Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice Namespace
|
default ListSipMediaApplicationsResponse |
listSipMediaApplications(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest)
Deprecated.
Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice Namespace
|
default ListSipMediaApplicationsIterable |
listSipMediaApplicationsPaginator(Consumer<ListSipMediaApplicationsRequest.Builder> listSipMediaApplicationsRequest)
Deprecated.
Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice Namespace
|
default ListSipMediaApplicationsIterable |
listSipMediaApplicationsPaginator(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest)
Deprecated.
Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice Namespace
|
default ListSipRulesResponse |
listSipRules(Consumer<ListSipRulesRequest.Builder> listSipRulesRequest)
Deprecated.
Replaced by ListSipRules in the Amazon Chime SDK Voice Namespace
|
default ListSipRulesResponse |
listSipRules(ListSipRulesRequest listSipRulesRequest)
Deprecated.
Replaced by ListSipRules in the Amazon Chime SDK Voice Namespace
|
default ListSipRulesIterable |
listSipRulesPaginator(Consumer<ListSipRulesRequest.Builder> listSipRulesRequest)
Deprecated.
Replaced by ListSipRules in the Amazon Chime SDK Voice Namespace
|
default ListSipRulesIterable |
listSipRulesPaginator(ListSipRulesRequest listSipRulesRequest)
Deprecated.
Replaced by ListSipRules in the Amazon Chime SDK Voice Namespace
|
default ListSupportedPhoneNumberCountriesResponse |
listSupportedPhoneNumberCountries(Consumer<ListSupportedPhoneNumberCountriesRequest.Builder> listSupportedPhoneNumberCountriesRequest)
Lists supported phone number countries.
|
default ListSupportedPhoneNumberCountriesResponse |
listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest)
Lists supported phone number countries.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Deprecated.
Replaced by ListTagsForResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon
Chime SDK Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Deprecated.
Replaced by ListTagsForResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon
Chime SDK Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
|
default ListUsersResponse |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
default ListUsersResponse |
listUsers(ListUsersRequest listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
default ListUsersIterable |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
default ListUsersIterable |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists the users that belong to the specified Amazon Chime account.
|
default ListVoiceConnectorGroupsResponse |
listVoiceConnectorGroups(Consumer<ListVoiceConnectorGroupsRequest.Builder> listVoiceConnectorGroupsRequest)
Deprecated.
Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorGroupsResponse |
listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest)
Deprecated.
Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorGroupsIterable |
listVoiceConnectorGroupsPaginator(Consumer<ListVoiceConnectorGroupsRequest.Builder> listVoiceConnectorGroupsRequest)
Deprecated.
Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorGroupsIterable |
listVoiceConnectorGroupsPaginator(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest)
Deprecated.
Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorsResponse |
listVoiceConnectors(Consumer<ListVoiceConnectorsRequest.Builder> listVoiceConnectorsRequest)
Deprecated.
Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorsResponse |
listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest)
Deprecated.
Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorsIterable |
listVoiceConnectorsPaginator(Consumer<ListVoiceConnectorsRequest.Builder> listVoiceConnectorsRequest)
Deprecated.
Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorsIterable |
listVoiceConnectorsPaginator(ListVoiceConnectorsRequest listVoiceConnectorsRequest)
Deprecated.
Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorTerminationCredentialsResponse |
listVoiceConnectorTerminationCredentials(Consumer<ListVoiceConnectorTerminationCredentialsRequest.Builder> listVoiceConnectorTerminationCredentialsRequest)
Deprecated.
Replaced by ListVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
|
default ListVoiceConnectorTerminationCredentialsResponse |
listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest)
Deprecated.
Replaced by ListVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
|
default LogoutUserResponse |
logoutUser(Consumer<LogoutUserRequest.Builder> logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
|
default LogoutUserResponse |
logoutUser(LogoutUserRequest logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
|
default PutAppInstanceRetentionSettingsResponse |
putAppInstanceRetentionSettings(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest)
Deprecated.
Replaced by PutAppInstanceRetentionSettings in the Amazon Chime SDK Identity Namespace
|
default PutAppInstanceRetentionSettingsResponse |
putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest)
Deprecated.
Replaced by PutAppInstanceRetentionSettings in the Amazon Chime SDK Identity Namespace
|
default PutAppInstanceStreamingConfigurationsResponse |
putAppInstanceStreamingConfigurations(Consumer<PutAppInstanceStreamingConfigurationsRequest.Builder> putAppInstanceStreamingConfigurationsRequest)
Deprecated.
Replaced by PutAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
|
default PutAppInstanceStreamingConfigurationsResponse |
putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest putAppInstanceStreamingConfigurationsRequest)
Deprecated.
Replaced by PutAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespace
|
default PutEventsConfigurationResponse |
putEventsConfiguration(Consumer<PutEventsConfigurationRequest.Builder> putEventsConfigurationRequest)
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
|
default PutEventsConfigurationResponse |
putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest)
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
|
default PutRetentionSettingsResponse |
putRetentionSettings(Consumer<PutRetentionSettingsRequest.Builder> putRetentionSettingsRequest)
Puts retention settings for the specified Amazon Chime Enterprise account.
|
default PutRetentionSettingsResponse |
putRetentionSettings(PutRetentionSettingsRequest putRetentionSettingsRequest)
Puts retention settings for the specified Amazon Chime Enterprise account.
|
default PutSipMediaApplicationLoggingConfigurationResponse |
putSipMediaApplicationLoggingConfiguration(Consumer<PutSipMediaApplicationLoggingConfigurationRequest.Builder> putSipMediaApplicationLoggingConfigurationRequest)
Deprecated.
Replaced by PutSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice Namespace
|
default PutSipMediaApplicationLoggingConfigurationResponse |
putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest putSipMediaApplicationLoggingConfigurationRequest)
Deprecated.
Replaced by PutSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorEmergencyCallingConfigurationResponse |
putVoiceConnectorEmergencyCallingConfiguration(Consumer<PutVoiceConnectorEmergencyCallingConfigurationRequest.Builder> putVoiceConnectorEmergencyCallingConfigurationRequest)
Deprecated.
Replaced by PutVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorEmergencyCallingConfigurationResponse |
putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest putVoiceConnectorEmergencyCallingConfigurationRequest)
Deprecated.
Replaced by PutVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorLoggingConfigurationResponse |
putVoiceConnectorLoggingConfiguration(Consumer<PutVoiceConnectorLoggingConfigurationRequest.Builder> putVoiceConnectorLoggingConfigurationRequest)
Deprecated.
Replaced by PutVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorLoggingConfigurationResponse |
putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest putVoiceConnectorLoggingConfigurationRequest)
Deprecated.
Replaced by PutVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorOriginationResponse |
putVoiceConnectorOrigination(Consumer<PutVoiceConnectorOriginationRequest.Builder> putVoiceConnectorOriginationRequest)
Deprecated.
Replaced by PutVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorOriginationResponse |
putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest)
Deprecated.
Replaced by PutVoiceConnectorOrigination in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorProxyResponse |
putVoiceConnectorProxy(Consumer<PutVoiceConnectorProxyRequest.Builder> putVoiceConnectorProxyRequest)
Deprecated.
Replaced by PutVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorProxyResponse |
putVoiceConnectorProxy(PutVoiceConnectorProxyRequest putVoiceConnectorProxyRequest)
Deprecated.
Replaced by PutVoiceConnectorProxy in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorStreamingConfigurationResponse |
putVoiceConnectorStreamingConfiguration(Consumer<PutVoiceConnectorStreamingConfigurationRequest.Builder> putVoiceConnectorStreamingConfigurationRequest)
Deprecated.
Replaced by PutVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorStreamingConfigurationResponse |
putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest putVoiceConnectorStreamingConfigurationRequest)
Deprecated.
Replaced by PutVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorTerminationResponse |
putVoiceConnectorTermination(Consumer<PutVoiceConnectorTerminationRequest.Builder> putVoiceConnectorTerminationRequest)
Deprecated.
Replaced by PutVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorTerminationResponse |
putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest)
Deprecated.
Replaced by PutVoiceConnectorTermination in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorTerminationCredentialsResponse |
putVoiceConnectorTerminationCredentials(Consumer<PutVoiceConnectorTerminationCredentialsRequest.Builder> putVoiceConnectorTerminationCredentialsRequest)
Deprecated.
Replaced by PutVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
|
default PutVoiceConnectorTerminationCredentialsResponse |
putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest)
Deprecated.
Replaced by PutVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespace
|
default RedactChannelMessageResponse |
redactChannelMessage(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest)
Deprecated.
Replaced by RedactChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default RedactChannelMessageResponse |
redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest)
Deprecated.
Replaced by RedactChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default RedactConversationMessageResponse |
redactConversationMessage(Consumer<RedactConversationMessageRequest.Builder> redactConversationMessageRequest)
Redacts the specified message from the specified Amazon Chime conversation.
|
default RedactConversationMessageResponse |
redactConversationMessage(RedactConversationMessageRequest redactConversationMessageRequest)
Redacts the specified message from the specified Amazon Chime conversation.
|
default RedactRoomMessageResponse |
redactRoomMessage(Consumer<RedactRoomMessageRequest.Builder> redactRoomMessageRequest)
Redacts the specified message from the specified Amazon Chime channel.
|
default RedactRoomMessageResponse |
redactRoomMessage(RedactRoomMessageRequest redactRoomMessageRequest)
Redacts the specified message from the specified Amazon Chime channel.
|
default RegenerateSecurityTokenResponse |
regenerateSecurityToken(Consumer<RegenerateSecurityTokenRequest.Builder> regenerateSecurityTokenRequest)
Regenerates the security token for a bot.
|
default RegenerateSecurityTokenResponse |
regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest)
Regenerates the security token for a bot.
|
default ResetPersonalPinResponse |
resetPersonalPIN(Consumer<ResetPersonalPinRequest.Builder> resetPersonalPinRequest)
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
|
default ResetPersonalPinResponse |
resetPersonalPIN(ResetPersonalPinRequest resetPersonalPinRequest)
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
|
default RestorePhoneNumberResponse |
restorePhoneNumber(Consumer<RestorePhoneNumberRequest.Builder> restorePhoneNumberRequest)
Moves a phone number from the Deletion queue back into the phone number Inventory.
|
default RestorePhoneNumberResponse |
restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest)
Moves a phone number from the Deletion queue back into the phone number Inventory.
|
default SearchAvailablePhoneNumbersResponse |
searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest)
Searches for phone numbers that can be ordered.
|
default SearchAvailablePhoneNumbersResponse |
searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches for phone numbers that can be ordered.
|
default SearchAvailablePhoneNumbersIterable |
searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest)
Searches for phone numbers that can be ordered.
|
default SearchAvailablePhoneNumbersIterable |
searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
Searches for phone numbers that can be ordered.
|
default SendChannelMessageResponse |
sendChannelMessage(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest)
Deprecated.
Replaced by SendChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default SendChannelMessageResponse |
sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest)
Deprecated.
Replaced by SendChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default ChimeServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartMeetingTranscriptionResponse |
startMeetingTranscription(Consumer<StartMeetingTranscriptionRequest.Builder> startMeetingTranscriptionRequest)
Deprecated.
Replaced by StartMeetingTranscription in the Amazon Chime SDK Meetings Namespace
|
default StartMeetingTranscriptionResponse |
startMeetingTranscription(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest)
Deprecated.
Replaced by StartMeetingTranscription in the Amazon Chime SDK Meetings Namespace
|
default StopMeetingTranscriptionResponse |
stopMeetingTranscription(Consumer<StopMeetingTranscriptionRequest.Builder> stopMeetingTranscriptionRequest)
Deprecated.
Replaced by StopMeetingTranscription in the Amazon Chime SDK Meetings Namespace
|
default StopMeetingTranscriptionResponse |
stopMeetingTranscription(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest)
Deprecated.
Replaced by StopMeetingTranscription in the Amazon Chime SDK Meetings Namespace
|
default TagAttendeeResponse |
tagAttendee(Consumer<TagAttendeeRequest.Builder> tagAttendeeRequest)
Deprecated.
Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application
to remove calls to this API.
|
default TagAttendeeResponse |
tagAttendee(TagAttendeeRequest tagAttendeeRequest)
Deprecated.
Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application
to remove calls to this API.
|
default TagMeetingResponse |
tagMeeting(Consumer<TagMeetingRequest.Builder> tagMeetingRequest)
Deprecated.
Use TagResource in the Amazon Chime SDK Meetings Namespace.
|
default TagMeetingResponse |
tagMeeting(TagMeetingRequest tagMeetingRequest)
Deprecated.
Use TagResource in the Amazon Chime SDK Meetings Namespace.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Deprecated.
Replaced by TagResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon Chime SDK
Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Deprecated.
Replaced by TagResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon Chime SDK
Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
|
default UntagAttendeeResponse |
untagAttendee(Consumer<UntagAttendeeRequest.Builder> untagAttendeeRequest)
Deprecated.
Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application
to remove calls to this API.
|
default UntagAttendeeResponse |
untagAttendee(UntagAttendeeRequest untagAttendeeRequest)
Deprecated.
Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace. Update your application
to remove calls to this API.
|
default UntagMeetingResponse |
untagMeeting(Consumer<UntagMeetingRequest.Builder> untagMeetingRequest)
Deprecated.
Use UntagResource in the Amazon Chime SDK Meetings Namespace.
|
default UntagMeetingResponse |
untagMeeting(UntagMeetingRequest untagMeetingRequest)
Deprecated.
Use UntagResource in the Amazon Chime SDK Meetings Namespace.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deprecated.
Replaced by UntagResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon Chime SDK
Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Deprecated.
Replaced by UntagResource in the Amazon Chime SDK Voice, Amazon Chime SDK Meetings, Amazon Chime SDK
Identity, Amazon Chime SDK Messaging, and Amazon Chime SDK Media Pipelines Namespaces
|
default UpdateAccountResponse |
updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest)
Updates account details for the specified Amazon Chime account.
|
default UpdateAccountResponse |
updateAccount(UpdateAccountRequest updateAccountRequest)
Updates account details for the specified Amazon Chime account.
|
default UpdateAccountSettingsResponse |
updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
Updates the settings for the specified Amazon Chime account.
|
default UpdateAccountSettingsResponse |
updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the settings for the specified Amazon Chime account.
|
default UpdateAppInstanceResponse |
updateAppInstance(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest)
Deprecated.
Replaced by UpdateAppInstance in the Amazon Chime SDK Identity Namespace
|
default UpdateAppInstanceResponse |
updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest)
Deprecated.
Replaced by UpdateAppInstance in the Amazon Chime SDK Identity Namespace
|
default UpdateAppInstanceUserResponse |
updateAppInstanceUser(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest)
Deprecated.
Replaced by UpdateAppInstanceUser in the Amazon Chime SDK Identity Namespace
|
default UpdateAppInstanceUserResponse |
updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest)
Deprecated.
Replaced by UpdateAppInstanceUser in the Amazon Chime SDK Identity Namespace
|
default UpdateBotResponse |
updateBot(Consumer<UpdateBotRequest.Builder> updateBotRequest)
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime
Enterprise account.
|
default UpdateBotResponse |
updateBot(UpdateBotRequest updateBotRequest)
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime
Enterprise account.
|
default UpdateChannelResponse |
updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
Deprecated.
Replaced by UpdateChannel in the Amazon Chime SDK Messaging Namespace
|
default UpdateChannelResponse |
updateChannel(UpdateChannelRequest updateChannelRequest)
Deprecated.
Replaced by UpdateChannel in the Amazon Chime SDK Messaging Namespace
|
default UpdateChannelMessageResponse |
updateChannelMessage(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest)
Deprecated.
Replaced by UpdateChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default UpdateChannelMessageResponse |
updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest)
Deprecated.
Replaced by UpdateChannelMessage in the Amazon Chime SDK Messaging Namespace
|
default UpdateChannelReadMarkerResponse |
updateChannelReadMarker(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest)
Deprecated.
Replaced by UpdateChannelReadMarker in the Amazon Chime SDK Messaging Namespace
|
default UpdateChannelReadMarkerResponse |
updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest)
Deprecated.
Replaced by UpdateChannelReadMarker in the Amazon Chime SDK Messaging Namespace
|
default UpdateGlobalSettingsResponse |
updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest)
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon
Chime Voice Connector settings.
|
default UpdateGlobalSettingsResponse |
updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon
Chime Voice Connector settings.
|
default UpdatePhoneNumberResponse |
updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest)
Updates phone number details, such as product type or calling name, for the specified phone number ID.
|
default UpdatePhoneNumberResponse |
updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
Updates phone number details, such as product type or calling name, for the specified phone number ID.
|
default UpdatePhoneNumberSettingsResponse |
updatePhoneNumberSettings(Consumer<UpdatePhoneNumberSettingsRequest.Builder> updatePhoneNumberSettingsRequest)
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
|
default UpdatePhoneNumberSettingsResponse |
updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest)
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
|
default UpdateProxySessionResponse |
updateProxySession(Consumer<UpdateProxySessionRequest.Builder> updateProxySessionRequest)
Deprecated.
Replaced by UpdateProxySession in the Amazon Chime SDK Voice Namespace
|
default UpdateProxySessionResponse |
updateProxySession(UpdateProxySessionRequest updateProxySessionRequest)
Deprecated.
Replaced by UpdateProxySession in the Amazon Chime SDK Voice Namespace
|
default UpdateRoomResponse |
updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest)
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
|
default UpdateRoomResponse |
updateRoom(UpdateRoomRequest updateRoomRequest)
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
|
default UpdateRoomMembershipResponse |
updateRoomMembership(Consumer<UpdateRoomMembershipRequest.Builder> updateRoomMembershipRequest)
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
|
default UpdateRoomMembershipResponse |
updateRoomMembership(UpdateRoomMembershipRequest updateRoomMembershipRequest)
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
|
default UpdateSipMediaApplicationResponse |
updateSipMediaApplication(Consumer<UpdateSipMediaApplicationRequest.Builder> updateSipMediaApplicationRequest)
Deprecated.
Replaced by UpdateSipMediaApplication in the Amazon Chime SDK Voice Namespace
|
default UpdateSipMediaApplicationResponse |
updateSipMediaApplication(UpdateSipMediaApplicationRequest updateSipMediaApplicationRequest)
Deprecated.
Replaced by UpdateSipMediaApplication in the Amazon Chime SDK Voice Namespace
|
default UpdateSipMediaApplicationCallResponse |
updateSipMediaApplicationCall(Consumer<UpdateSipMediaApplicationCallRequest.Builder> updateSipMediaApplicationCallRequest)
Deprecated.
Replaced by UpdateSipMediaApplicationCall in the Amazon Chime SDK Voice Namespace
|
default UpdateSipMediaApplicationCallResponse |
updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest updateSipMediaApplicationCallRequest)
Deprecated.
Replaced by UpdateSipMediaApplicationCall in the Amazon Chime SDK Voice Namespace
|
default UpdateSipRuleResponse |
updateSipRule(Consumer<UpdateSipRuleRequest.Builder> updateSipRuleRequest)
Deprecated.
Replaced by UpdateSipRule in the Amazon Chime SDK Voice Namespace
|
default UpdateSipRuleResponse |
updateSipRule(UpdateSipRuleRequest updateSipRuleRequest)
Deprecated.
Replaced by UpdateSipRule in the Amazon Chime SDK Voice Namespace
|
default UpdateUserResponse |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates user details for a specified user ID.
|
default UpdateUserResponse |
updateUser(UpdateUserRequest updateUserRequest)
Updates user details for a specified user ID.
|
default UpdateUserSettingsResponse |
updateUserSettings(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest)
Updates the settings for the specified user, such as phone number settings.
|
default UpdateUserSettingsResponse |
updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest)
Updates the settings for the specified user, such as phone number settings.
|
default UpdateVoiceConnectorResponse |
updateVoiceConnector(Consumer<UpdateVoiceConnectorRequest.Builder> updateVoiceConnectorRequest)
Deprecated.
Replaced by UpdateVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default UpdateVoiceConnectorResponse |
updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest)
Deprecated.
Replaced by UpdateVoiceConnector in the Amazon Chime SDK Voice Namespace
|
default UpdateVoiceConnectorGroupResponse |
updateVoiceConnectorGroup(Consumer<UpdateVoiceConnectorGroupRequest.Builder> updateVoiceConnectorGroupRequest)
Deprecated.
Replaced by UpdateVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default UpdateVoiceConnectorGroupResponse |
updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest updateVoiceConnectorGroupRequest)
Deprecated.
Replaced by UpdateVoiceConnectorGroup in the Amazon Chime SDK Voice Namespace
|
default ValidateE911AddressResponse |
validateE911Address(Consumer<ValidateE911AddressRequest.Builder> validateE911AddressRequest)
Deprecated.
Replaced by ValidateE911Address in the Amazon Chime SDK Voice Namespace
|
default ValidateE911AddressResponse |
validateE911Address(ValidateE911AddressRequest validateE911AddressRequest)
Deprecated.
Replaced by ValidateE911Address in the Amazon Chime SDK Voice Namespace
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AssociatePhoneNumberWithUserResponse associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Associates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociatePhoneNumberWithUserResponse associatePhoneNumberWithUser(Consumer<AssociatePhoneNumberWithUserRequest.Builder> associatePhoneNumberWithUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Associates a phone number with the specified Amazon Chime user.
This is a convenience which creates an instance of the AssociatePhoneNumberWithUserRequest.Builder
avoiding the need to create one manually via AssociatePhoneNumberWithUserRequest.builder()
associatePhoneNumberWithUserRequest - A Consumer that will call methods on
AssociatePhoneNumberWithUserRequest.Builder to create
a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default AssociatePhoneNumbersWithVoiceConnectorResponse associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
associatePhoneNumbersWithVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default AssociatePhoneNumbersWithVoiceConnectorResponse associatePhoneNumbersWithVoiceConnector(Consumer<AssociatePhoneNumbersWithVoiceConnectorRequest.Builder> associatePhoneNumbersWithVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
AssociatePhoneNumbersWithVoiceConnectorRequest.Builder avoiding the need to create one manually via
AssociatePhoneNumbersWithVoiceConnectorRequest.builder()
associatePhoneNumbersWithVoiceConnectorRequest - A Consumer that will call methods on
AssociatePhoneNumbersWithVoiceConnectorRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default AssociatePhoneNumbersWithVoiceConnectorGroupResponse associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest associatePhoneNumbersWithVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
associatePhoneNumbersWithVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default AssociatePhoneNumbersWithVoiceConnectorGroupResponse associatePhoneNumbersWithVoiceConnectorGroup(Consumer<AssociatePhoneNumbersWithVoiceConnectorGroupRequest.Builder> associatePhoneNumbersWithVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
AssociatePhoneNumbersWithVoiceConnectorGroupRequest.Builder avoiding the need to create one manually via
AssociatePhoneNumbersWithVoiceConnectorGroupRequest.builder()
associatePhoneNumbersWithVoiceConnectorGroupRequest - A Consumer that will call methods on
AssociatePhoneNumbersWithVoiceConnectorGroupRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateSigninDelegateGroupsWithAccountResponse associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
associateSigninDelegateGroupsWithAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateSigninDelegateGroupsWithAccountResponse associateSigninDelegateGroupsWithAccount(Consumer<AssociateSigninDelegateGroupsWithAccountRequest.Builder> associateSigninDelegateGroupsWithAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
This is a convenience which creates an instance of the
AssociateSigninDelegateGroupsWithAccountRequest.Builder avoiding the need to create one manually via
AssociateSigninDelegateGroupsWithAccountRequest.builder()
associateSigninDelegateGroupsWithAccountRequest - A Consumer that will call methods on
AssociateSigninDelegateGroupsWithAccountRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default BatchCreateAttendeeResponse batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
batchCreateAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default BatchCreateAttendeeResponse batchCreateAttendee(Consumer<BatchCreateAttendeeRequest.Builder> batchCreateAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the BatchCreateAttendeeRequest.Builder avoiding the
need to create one manually via BatchCreateAttendeeRequest.builder()
batchCreateAttendeeRequest - A Consumer that will call methods on
BatchCreateAttendeeRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default BatchCreateChannelMembershipResponse batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest) throws ServiceFailureException, ServiceUnavailableException, UnauthorizedClientException, BadRequestException, ForbiddenException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
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.
batchCreateChannelMembershipRequest - ServiceFailureException - The service encountered an unexpected error.ServiceUnavailableException - The service is currently unavailable.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default BatchCreateChannelMembershipResponse batchCreateChannelMembership(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest) throws ServiceFailureException, ServiceUnavailableException, UnauthorizedClientException, BadRequestException, ForbiddenException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the BatchCreateChannelMembershipRequest.Builder
avoiding the need to create one manually via BatchCreateChannelMembershipRequest.builder()
batchCreateChannelMembershipRequest - A Consumer that will call methods on
BatchCreateChannelMembershipRequest.Builder to create
a request.ServiceFailureException - The service encountered an unexpected error.ServiceUnavailableException - The service is currently unavailable.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchCreateRoomMembershipResponse batchCreateRoomMembership(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
batchCreateRoomMembershipRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchCreateRoomMembershipResponse batchCreateRoomMembership(Consumer<BatchCreateRoomMembershipRequest.Builder> batchCreateRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the BatchCreateRoomMembershipRequest.Builder avoiding
the need to create one manually via BatchCreateRoomMembershipRequest.builder()
batchCreateRoomMembershipRequest - A Consumer that will call methods on
BatchCreateRoomMembershipRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeletePhoneNumberResponse batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
batchDeletePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeletePhoneNumberResponse batchDeletePhoneNumber(Consumer<BatchDeletePhoneNumberRequest.Builder> batchDeletePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the BatchDeletePhoneNumberRequest.Builder avoiding the
need to create one manually via BatchDeletePhoneNumberRequest.builder()
batchDeletePhoneNumberRequest - A Consumer that will call methods on
BatchDeletePhoneNumberRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchSuspendUserResponse batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
batchSuspendUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchSuspendUserResponse batchSuspendUser(Consumer<BatchSuspendUserRequest.Builder> batchSuspendUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the BatchSuspendUserRequest.Builder avoiding the need
to create one manually via BatchSuspendUserRequest.builder()
batchSuspendUserRequest - A Consumer that will call methods on
BatchSuspendUserRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchUnsuspendUserResponse batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
batchUnsuspendUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchUnsuspendUserResponse batchUnsuspendUser(Consumer<BatchUnsuspendUserRequest.Builder> batchUnsuspendUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the BatchUnsuspendUserRequest.Builder avoiding the
need to create one manually via BatchUnsuspendUserRequest.builder()
batchUnsuspendUserRequest - A Consumer that will call methods on
BatchUnsuspendUserRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchUpdatePhoneNumberResponse batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
batchUpdatePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchUpdatePhoneNumberResponse batchUpdatePhoneNumber(Consumer<BatchUpdatePhoneNumberRequest.Builder> batchUpdatePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the BatchUpdatePhoneNumberRequest.Builder avoiding the
need to create one manually via BatchUpdatePhoneNumberRequest.builder()
batchUpdatePhoneNumberRequest - A Consumer that will call methods on
BatchUpdatePhoneNumberRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchUpdateUserResponse batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
batchUpdateUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchUpdateUserResponse batchUpdateUser(Consumer<BatchUpdateUserRequest.Builder> batchUpdateUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the BatchUpdateUserRequest.Builder avoiding the need
to create one manually via BatchUpdateUserRequest.builder()
batchUpdateUserRequest - A Consumer that will call methods on
BatchUpdateUserRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAccountResponse createAccount(CreateAccountRequest createAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAccountResponse createAccount(Consumer<CreateAccountRequest.Builder> createAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateAccountRequest.Builder avoiding the need to
create one manually via CreateAccountRequest.builder()
createAccountRequest - A Consumer that will call methods on
CreateAccountRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateAppInstanceResponse createAppInstance(CreateAppInstanceRequest createAppInstanceRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createAppInstanceRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateAppInstanceResponse createAppInstance(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateAppInstanceRequest.Builder avoiding the need
to create one manually via CreateAppInstanceRequest.builder()
createAppInstanceRequest - A Consumer that will call methods on
CreateAppInstanceRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateAppInstanceAdminResponse createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createAppInstanceAdminRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateAppInstanceAdminResponse createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateAppInstanceAdminRequest.Builder avoiding the
need to create one manually via CreateAppInstanceAdminRequest.builder()
createAppInstanceAdminRequest - A Consumer that will call methods on
CreateAppInstanceAdminRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateAppInstanceUserResponse createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateAppInstanceUserResponse createAppInstanceUser(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateAppInstanceUserRequest.Builder avoiding the
need to create one manually via CreateAppInstanceUserRequest.builder()
createAppInstanceUserRequest - A Consumer that will call methods on
CreateAppInstanceUserRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateAttendeeResponse createAttendee(CreateAttendeeRequest createAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateAttendeeResponse createAttendee(Consumer<CreateAttendeeRequest.Builder> createAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateAttendeeRequest.Builder avoiding the need to
create one manually via CreateAttendeeRequest.builder()
createAttendeeRequest - A Consumer that will call methods on
CreateAttendeeRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBotResponse createBot(CreateBotRequest createBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Creates a bot for an Amazon Chime Enterprise account.
createBotRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBotResponse createBot(Consumer<CreateBotRequest.Builder> createBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Creates a bot for an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the CreateBotRequest.Builder avoiding the need to
create one manually via CreateBotRequest.builder()
createBotRequest - A Consumer that will call methods on
CreateBotRequest.Builder to create a request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateChannelResponse createChannel(CreateChannelRequest createChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateChannelResponse createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateChannelRequest.Builder avoiding the need to
create one manually via CreateChannelRequest.builder()
createChannelRequest - A Consumer that will call methods on
CreateChannelRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateChannelBanResponse createChannelBan(CreateChannelBanRequest createChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateChannelBanResponse createChannelBan(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateChannelBanRequest.Builder avoiding the need
to create one manually via CreateChannelBanRequest.builder()
createChannelBanRequest - A Consumer that will call methods on
CreateChannelBanRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateChannelMembershipResponse createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateChannelMembershipResponse createChannelMembership(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateChannelMembershipRequest.Builder avoiding
the need to create one manually via CreateChannelMembershipRequest.builder()
createChannelMembershipRequest - A Consumer that will call methods on
CreateChannelMembershipRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateChannelModeratorResponse createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateChannelModeratorResponse createChannelModerator(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateChannelModeratorRequest.Builder avoiding the
need to create one manually via CreateChannelModeratorRequest.builder()
createChannelModeratorRequest - A Consumer that will call methods on
CreateChannelModeratorRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateMediaCapturePipelineResponse createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest) throws ResourceLimitExceededException, ForbiddenException, BadRequestException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createMediaCapturePipelineRequest - ResourceLimitExceededException - The request exceeds the resource limit.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateMediaCapturePipelineResponse createMediaCapturePipeline(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest) throws ResourceLimitExceededException, ForbiddenException, BadRequestException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateMediaCapturePipelineRequest.Builder avoiding
the need to create one manually via CreateMediaCapturePipelineRequest.builder()
createMediaCapturePipelineRequest - A Consumer that will call methods on
CreateMediaCapturePipelineRequest.Builder to create a
request.ResourceLimitExceededException - The request exceeds the resource limit.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateMeetingResponse createMeeting(CreateMeetingRequest createMeetingRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateMeetingResponse createMeeting(Consumer<CreateMeetingRequest.Builder> createMeetingRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateMeetingRequest.Builder avoiding the need to
create one manually via CreateMeetingRequest.builder()
createMeetingRequest - A Consumer that will call methods on
CreateMeetingRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateMeetingDialOutResponse createMeetingDialOut(CreateMeetingDialOutRequest createMeetingDialOutRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, AccessDeniedException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createMeetingDialOutRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateMeetingDialOutResponse createMeetingDialOut(Consumer<CreateMeetingDialOutRequest.Builder> createMeetingDialOutRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, AccessDeniedException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateMeetingDialOutRequest.Builder avoiding the
need to create one manually via CreateMeetingDialOutRequest.builder()
createMeetingDialOutRequest - A Consumer that will call methods on
CreateMeetingDialOutRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateMeetingWithAttendeesResponse createMeetingWithAttendees(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createMeetingWithAttendeesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateMeetingWithAttendeesResponse createMeetingWithAttendees(Consumer<CreateMeetingWithAttendeesRequest.Builder> createMeetingWithAttendeesRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateMeetingWithAttendeesRequest.Builder avoiding
the need to create one manually via CreateMeetingWithAttendeesRequest.builder()
createMeetingWithAttendeesRequest - A Consumer that will call methods on
CreateMeetingWithAttendeesRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePhoneNumberOrderResponse createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createPhoneNumberOrderRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePhoneNumberOrderResponse createPhoneNumberOrder(Consumer<CreatePhoneNumberOrderRequest.Builder> createPhoneNumberOrderRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreatePhoneNumberOrderRequest.Builder avoiding the
need to create one manually via CreatePhoneNumberOrderRequest.builder()
createPhoneNumberOrderRequest - A Consumer that will call methods on
CreatePhoneNumberOrderRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateProxySessionResponse createProxySession(CreateProxySessionRequest createProxySessionRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createProxySessionRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateProxySessionResponse createProxySession(Consumer<CreateProxySessionRequest.Builder> createProxySessionRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateProxySessionRequest.Builder avoiding the
need to create one manually via CreateProxySessionRequest.builder()
createProxySessionRequest - A Consumer that will call methods on
CreateProxySessionRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRoomResponse createRoom(CreateRoomRequest createRoomRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Creates a chat room for the specified Amazon Chime Enterprise account.
createRoomRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRoomResponse createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Creates a chat room for the specified Amazon Chime Enterprise account.
This is a convenience which creates an instance of the CreateRoomRequest.Builder avoiding the need to
create one manually via CreateRoomRequest.builder()
createRoomRequest - A Consumer that will call methods on
CreateRoomRequest.Builder to create a request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRoomMembershipResponse createRoomMembership(CreateRoomMembershipRequest createRoomMembershipRequest) throws ConflictException, UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createRoomMembershipRequest - ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRoomMembershipResponse createRoomMembership(Consumer<CreateRoomMembershipRequest.Builder> createRoomMembershipRequest) throws ConflictException, UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateRoomMembershipRequest.Builder avoiding the
need to create one manually via CreateRoomMembershipRequest.builder()
createRoomMembershipRequest - A Consumer that will call methods on
CreateRoomMembershipRequest.Builder to create a
request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateSipMediaApplicationResponse createSipMediaApplication(CreateSipMediaApplicationRequest createSipMediaApplicationRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createSipMediaApplicationRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateSipMediaApplicationResponse createSipMediaApplication(Consumer<CreateSipMediaApplicationRequest.Builder> createSipMediaApplicationRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateSipMediaApplicationRequest.Builder avoiding
the need to create one manually via CreateSipMediaApplicationRequest.builder()
createSipMediaApplicationRequest - A Consumer that will call methods on
CreateSipMediaApplicationRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateSipMediaApplicationCallResponse createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest createSipMediaApplicationCallRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, AccessDeniedException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createSipMediaApplicationCallRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateSipMediaApplicationCallResponse createSipMediaApplicationCall(Consumer<CreateSipMediaApplicationCallRequest.Builder> createSipMediaApplicationCallRequest) throws BadRequestException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, AccessDeniedException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateSipMediaApplicationCallRequest.Builder
avoiding the need to create one manually via CreateSipMediaApplicationCallRequest.builder()
createSipMediaApplicationCallRequest - A Consumer that will call methods on
CreateSipMediaApplicationCallRequest.Builder to create
a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateSipRuleResponse createSipRule(CreateSipRuleRequest createSipRuleRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createSipRuleRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateSipRuleResponse createSipRule(Consumer<CreateSipRuleRequest.Builder> createSipRuleRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateSipRuleRequest.Builder avoiding the need to
create one manually via CreateSipRuleRequest.builder()
createSipRuleRequest - A Consumer that will call methods on
CreateSipRuleRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws UnauthorizedClientException, NotFoundException, ConflictException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Creates a user under the specified Amazon Chime account.
createUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws UnauthorizedClientException, NotFoundException, ConflictException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Creates a user under the specified Amazon Chime account.
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on
CreateUserRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateVoiceConnectorResponse createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createVoiceConnectorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateVoiceConnectorResponse createVoiceConnector(Consumer<CreateVoiceConnectorRequest.Builder> createVoiceConnectorRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateVoiceConnectorRequest.Builder avoiding the
need to create one manually via CreateVoiceConnectorRequest.builder()
createVoiceConnectorRequest - A Consumer that will call methods on
CreateVoiceConnectorRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateVoiceConnectorGroupResponse createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest createVoiceConnectorGroupRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
createVoiceConnectorGroupRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default CreateVoiceConnectorGroupResponse createVoiceConnectorGroup(Consumer<CreateVoiceConnectorGroupRequest.Builder> createVoiceConnectorGroupRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the CreateVoiceConnectorGroupRequest.Builder avoiding
the need to create one manually via CreateVoiceConnectorGroupRequest.builder()
createVoiceConnectorGroupRequest - A Consumer that will call methods on
CreateVoiceConnectorGroupRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccountResponse deleteAccount(DeleteAccountRequest deleteAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, UnprocessableEntityException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAccountResponse deleteAccount(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, UnprocessableEntityException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteAccountRequest.Builder avoiding the need to
create one manually via DeleteAccountRequest.builder()
deleteAccountRequest - A Consumer that will call methods on
DeleteAccountRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAppInstanceResponse deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteAppInstanceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAppInstanceResponse deleteAppInstance(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteAppInstanceRequest.Builder avoiding the need
to create one manually via DeleteAppInstanceRequest.builder()
deleteAppInstanceRequest - A Consumer that will call methods on
DeleteAppInstanceRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAppInstanceAdminResponse deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteAppInstanceAdminRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAppInstanceAdminResponse deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteAppInstanceAdminRequest.Builder avoiding the
need to create one manually via DeleteAppInstanceAdminRequest.builder()
deleteAppInstanceAdminRequest - A Consumer that will call methods on
DeleteAppInstanceAdminRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAppInstanceStreamingConfigurationsResponse deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest deleteAppInstanceStreamingConfigurationsRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteAppInstanceStreamingConfigurationsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAppInstanceStreamingConfigurationsResponse deleteAppInstanceStreamingConfigurations(Consumer<DeleteAppInstanceStreamingConfigurationsRequest.Builder> deleteAppInstanceStreamingConfigurationsRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
DeleteAppInstanceStreamingConfigurationsRequest.Builder avoiding the need to create one manually via
DeleteAppInstanceStreamingConfigurationsRequest.builder()
deleteAppInstanceStreamingConfigurationsRequest - A Consumer that will call methods on
DeleteAppInstanceStreamingConfigurationsRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAppInstanceUserResponse deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAppInstanceUserResponse deleteAppInstanceUser(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteAppInstanceUserRequest.Builder avoiding the
need to create one manually via DeleteAppInstanceUserRequest.builder()
deleteAppInstanceUserRequest - A Consumer that will call methods on
DeleteAppInstanceUserRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAttendeeResponse deleteAttendee(DeleteAttendeeRequest deleteAttendeeRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteAttendeeResponse deleteAttendee(Consumer<DeleteAttendeeRequest.Builder> deleteAttendeeRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteAttendeeRequest.Builder avoiding the need to
create one manually via DeleteAttendeeRequest.builder()
deleteAttendeeRequest - A Consumer that will call methods on
DeleteAttendeeRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelResponse deleteChannel(DeleteChannelRequest deleteChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelResponse deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteChannelRequest.Builder avoiding the need to
create one manually via DeleteChannelRequest.builder()
deleteChannelRequest - A Consumer that will call methods on
DeleteChannelRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelBanResponse deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelBanResponse deleteChannelBan(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteChannelBanRequest.Builder avoiding the need
to create one manually via DeleteChannelBanRequest.builder()
deleteChannelBanRequest - A Consumer that will call methods on
DeleteChannelBanRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelMembershipResponse deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelMembershipResponse deleteChannelMembership(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteChannelMembershipRequest.Builder avoiding
the need to create one manually via DeleteChannelMembershipRequest.builder()
deleteChannelMembershipRequest - A Consumer that will call methods on
DeleteChannelMembershipRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelMessageResponse deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelMessageResponse deleteChannelMessage(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteChannelMessageRequest.Builder avoiding the
need to create one manually via DeleteChannelMessageRequest.builder()
deleteChannelMessageRequest - A Consumer that will call methods on
DeleteChannelMessageRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelModeratorResponse deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteChannelModeratorResponse deleteChannelModerator(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteChannelModeratorRequest.Builder avoiding the
need to create one manually via DeleteChannelModeratorRequest.builder()
deleteChannelModeratorRequest - A Consumer that will call methods on
DeleteChannelModeratorRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventsConfigurationResponse deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, AwsServiceException, SdkClientException, ChimeException
Deletes the events configuration that allows a bot to receive outgoing events.
deleteEventsConfigurationRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventsConfigurationResponse deleteEventsConfiguration(Consumer<DeleteEventsConfigurationRequest.Builder> deleteEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, AwsServiceException, SdkClientException, ChimeException
Deletes the events configuration that allows a bot to receive outgoing events.
This is a convenience which creates an instance of the DeleteEventsConfigurationRequest.Builder avoiding
the need to create one manually via DeleteEventsConfigurationRequest.builder()
deleteEventsConfigurationRequest - A Consumer that will call methods on
DeleteEventsConfigurationRequest.Builder to create a
request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteMediaCapturePipelineResponse deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest) throws ForbiddenException, NotFoundException, BadRequestException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteMediaCapturePipelineRequest - ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteMediaCapturePipelineResponse deleteMediaCapturePipeline(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest) throws ForbiddenException, NotFoundException, BadRequestException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteMediaCapturePipelineRequest.Builder avoiding
the need to create one manually via DeleteMediaCapturePipelineRequest.builder()
deleteMediaCapturePipelineRequest - A Consumer that will call methods on
DeleteMediaCapturePipelineRequest.Builder to create a
request.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteMeetingResponse deleteMeeting(DeleteMeetingRequest deleteMeetingRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteMeetingResponse deleteMeeting(Consumer<DeleteMeetingRequest.Builder> deleteMeetingRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteMeetingRequest.Builder avoiding the need to
create one manually via DeleteMeetingRequest.builder()
deleteMeetingRequest - A Consumer that will call methods on
DeleteMeetingRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePhoneNumberResponse deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deletePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePhoneNumberResponse deletePhoneNumber(Consumer<DeletePhoneNumberRequest.Builder> deletePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeletePhoneNumberRequest.Builder avoiding the need
to create one manually via DeletePhoneNumberRequest.builder()
deletePhoneNumberRequest - A Consumer that will call methods on
DeletePhoneNumberRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteProxySessionResponse deleteProxySession(DeleteProxySessionRequest deleteProxySessionRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteProxySessionRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteProxySessionResponse deleteProxySession(Consumer<DeleteProxySessionRequest.Builder> deleteProxySessionRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteProxySessionRequest.Builder avoiding the
need to create one manually via DeleteProxySessionRequest.builder()
deleteProxySessionRequest - A Consumer that will call methods on
DeleteProxySessionRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRoomResponse deleteRoom(DeleteRoomRequest deleteRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Deletes a chat room in an Amazon Chime Enterprise account.
deleteRoomRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRoomResponse deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Deletes a chat room in an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the DeleteRoomRequest.Builder avoiding the need to
create one manually via DeleteRoomRequest.builder()
deleteRoomRequest - A Consumer that will call methods on
DeleteRoomRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRoomMembershipResponse deleteRoomMembership(DeleteRoomMembershipRequest deleteRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Removes a member from a chat room in an Amazon Chime Enterprise account.
deleteRoomMembershipRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRoomMembershipResponse deleteRoomMembership(Consumer<DeleteRoomMembershipRequest.Builder> deleteRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Removes a member from a chat room in an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the DeleteRoomMembershipRequest.Builder avoiding the
need to create one manually via DeleteRoomMembershipRequest.builder()
deleteRoomMembershipRequest - A Consumer that will call methods on
DeleteRoomMembershipRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteSipMediaApplicationResponse deleteSipMediaApplication(DeleteSipMediaApplicationRequest deleteSipMediaApplicationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteSipMediaApplicationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteSipMediaApplicationResponse deleteSipMediaApplication(Consumer<DeleteSipMediaApplicationRequest.Builder> deleteSipMediaApplicationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteSipMediaApplicationRequest.Builder avoiding
the need to create one manually via DeleteSipMediaApplicationRequest.builder()
deleteSipMediaApplicationRequest - A Consumer that will call methods on
DeleteSipMediaApplicationRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteSipRuleResponse deleteSipRule(DeleteSipRuleRequest deleteSipRuleRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteSipRuleRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteSipRuleResponse deleteSipRule(Consumer<DeleteSipRuleRequest.Builder> deleteSipRuleRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteSipRuleRequest.Builder avoiding the need to
create one manually via DeleteSipRuleRequest.builder()
deleteSipRuleRequest - A Consumer that will call methods on
DeleteSipRuleRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorResponse deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorResponse deleteVoiceConnector(Consumer<DeleteVoiceConnectorRequest.Builder> deleteVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteVoiceConnectorRequest.Builder avoiding the
need to create one manually via DeleteVoiceConnectorRequest.builder()
deleteVoiceConnectorRequest - A Consumer that will call methods on
DeleteVoiceConnectorRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorEmergencyCallingConfigurationResponse deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest deleteVoiceConnectorEmergencyCallingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteVoiceConnectorEmergencyCallingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorEmergencyCallingConfigurationResponse deleteVoiceConnectorEmergencyCallingConfiguration(Consumer<DeleteVoiceConnectorEmergencyCallingConfigurationRequest.Builder> deleteVoiceConnectorEmergencyCallingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
DeleteVoiceConnectorEmergencyCallingConfigurationRequest.Builder avoiding the need to create one manually
via DeleteVoiceConnectorEmergencyCallingConfigurationRequest.builder()
deleteVoiceConnectorEmergencyCallingConfigurationRequest - A Consumer that will call methods on
DeleteVoiceConnectorEmergencyCallingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorGroupResponse deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest deleteVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorGroupResponse deleteVoiceConnectorGroup(Consumer<DeleteVoiceConnectorGroupRequest.Builder> deleteVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteVoiceConnectorGroupRequest.Builder avoiding
the need to create one manually via DeleteVoiceConnectorGroupRequest.builder()
deleteVoiceConnectorGroupRequest - A Consumer that will call methods on
DeleteVoiceConnectorGroupRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorOriginationResponse deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteVoiceConnectorOriginationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorOriginationResponse deleteVoiceConnectorOrigination(Consumer<DeleteVoiceConnectorOriginationRequest.Builder> deleteVoiceConnectorOriginationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteVoiceConnectorOriginationRequest.Builder
avoiding the need to create one manually via DeleteVoiceConnectorOriginationRequest.builder()
deleteVoiceConnectorOriginationRequest - A Consumer that will call methods on
DeleteVoiceConnectorOriginationRequest.Builder to
create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorProxyResponse deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest deleteVoiceConnectorProxyRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteVoiceConnectorProxyRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorProxyResponse deleteVoiceConnectorProxy(Consumer<DeleteVoiceConnectorProxyRequest.Builder> deleteVoiceConnectorProxyRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteVoiceConnectorProxyRequest.Builder avoiding
the need to create one manually via DeleteVoiceConnectorProxyRequest.builder()
deleteVoiceConnectorProxyRequest - A Consumer that will call methods on
DeleteVoiceConnectorProxyRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorStreamingConfigurationResponse deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest deleteVoiceConnectorStreamingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteVoiceConnectorStreamingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorStreamingConfigurationResponse deleteVoiceConnectorStreamingConfiguration(Consumer<DeleteVoiceConnectorStreamingConfigurationRequest.Builder> deleteVoiceConnectorStreamingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
DeleteVoiceConnectorStreamingConfigurationRequest.Builder avoiding the need to create one manually via
DeleteVoiceConnectorStreamingConfigurationRequest.builder()
deleteVoiceConnectorStreamingConfigurationRequest - A Consumer that will call methods on
DeleteVoiceConnectorStreamingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorTerminationResponse deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteVoiceConnectorTerminationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorTerminationResponse deleteVoiceConnectorTermination(Consumer<DeleteVoiceConnectorTerminationRequest.Builder> deleteVoiceConnectorTerminationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DeleteVoiceConnectorTerminationRequest.Builder
avoiding the need to create one manually via DeleteVoiceConnectorTerminationRequest.builder()
deleteVoiceConnectorTerminationRequest - A Consumer that will call methods on
DeleteVoiceConnectorTerminationRequest.Builder to
create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorTerminationCredentialsResponse deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
deleteVoiceConnectorTerminationCredentialsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DeleteVoiceConnectorTerminationCredentialsResponse deleteVoiceConnectorTerminationCredentials(Consumer<DeleteVoiceConnectorTerminationCredentialsRequest.Builder> deleteVoiceConnectorTerminationCredentialsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
DeleteVoiceConnectorTerminationCredentialsRequest.Builder avoiding the need to create one manually via
DeleteVoiceConnectorTerminationCredentialsRequest.builder()
deleteVoiceConnectorTerminationCredentialsRequest - A Consumer that will call methods on
DeleteVoiceConnectorTerminationCredentialsRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeAppInstanceResponse describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeAppInstanceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeAppInstanceResponse describeAppInstance(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DescribeAppInstanceRequest.Builder avoiding the
need to create one manually via DescribeAppInstanceRequest.builder()
describeAppInstanceRequest - A Consumer that will call methods on
DescribeAppInstanceRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeAppInstanceAdminResponse describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeAppInstanceAdminRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeAppInstanceAdminResponse describeAppInstanceAdmin(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DescribeAppInstanceAdminRequest.Builder avoiding
the need to create one manually via DescribeAppInstanceAdminRequest.builder()
describeAppInstanceAdminRequest - A Consumer that will call methods on
DescribeAppInstanceAdminRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeAppInstanceUserResponse describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeAppInstanceUserResponse describeAppInstanceUser(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DescribeAppInstanceUserRequest.Builder avoiding
the need to create one manually via DescribeAppInstanceUserRequest.builder()
describeAppInstanceUserRequest - A Consumer that will call methods on
DescribeAppInstanceUserRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelResponse describeChannel(DescribeChannelRequest describeChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelResponse describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DescribeChannelRequest.Builder avoiding the need
to create one manually via DescribeChannelRequest.builder()
describeChannelRequest - A Consumer that will call methods on
DescribeChannelRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelBanResponse describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelBanResponse describeChannelBan(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DescribeChannelBanRequest.Builder avoiding the
need to create one manually via DescribeChannelBanRequest.builder()
describeChannelBanRequest - A Consumer that will call methods on
DescribeChannelBanRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelMembershipResponse describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelMembershipResponse describeChannelMembership(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DescribeChannelMembershipRequest.Builder avoiding
the need to create one manually via DescribeChannelMembershipRequest.builder()
describeChannelMembershipRequest - A Consumer that will call methods on
DescribeChannelMembershipRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelMembershipForAppInstanceUserResponse describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeChannelMembershipForAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelMembershipForAppInstanceUserResponse describeChannelMembershipForAppInstanceUser(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
DescribeChannelMembershipForAppInstanceUserRequest.Builder avoiding the need to create one manually via
DescribeChannelMembershipForAppInstanceUserRequest.builder()
describeChannelMembershipForAppInstanceUserRequest - A Consumer that will call methods on
DescribeChannelMembershipForAppInstanceUserRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelModeratedByAppInstanceUserResponse describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeChannelModeratedByAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelModeratedByAppInstanceUserResponse describeChannelModeratedByAppInstanceUser(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
DescribeChannelModeratedByAppInstanceUserRequest.Builder avoiding the need to create one manually via
DescribeChannelModeratedByAppInstanceUserRequest.builder()
describeChannelModeratedByAppInstanceUserRequest - A Consumer that will call methods on
DescribeChannelModeratedByAppInstanceUserRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelModeratorResponse describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
describeChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DescribeChannelModeratorResponse describeChannelModerator(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the DescribeChannelModeratorRequest.Builder avoiding
the need to create one manually via DescribeChannelModeratorRequest.builder()
describeChannelModeratorRequest - A Consumer that will call methods on
DescribeChannelModeratorRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociatePhoneNumberFromUserResponse disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociatePhoneNumberFromUserResponse disassociatePhoneNumberFromUser(Consumer<DisassociatePhoneNumberFromUserRequest.Builder> disassociatePhoneNumberFromUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
This is a convenience which creates an instance of the DisassociatePhoneNumberFromUserRequest.Builder
avoiding the need to create one manually via DisassociatePhoneNumberFromUserRequest.builder()
disassociatePhoneNumberFromUserRequest - A Consumer that will call methods on
DisassociatePhoneNumberFromUserRequest.Builder to
create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DisassociatePhoneNumbersFromVoiceConnectorResponse disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
disassociatePhoneNumbersFromVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DisassociatePhoneNumbersFromVoiceConnectorResponse disassociatePhoneNumbersFromVoiceConnector(Consumer<DisassociatePhoneNumbersFromVoiceConnectorRequest.Builder> disassociatePhoneNumbersFromVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
DisassociatePhoneNumbersFromVoiceConnectorRequest.Builder avoiding the need to create one manually via
DisassociatePhoneNumbersFromVoiceConnectorRequest.builder()
disassociatePhoneNumbersFromVoiceConnectorRequest - A Consumer that will call methods on
DisassociatePhoneNumbersFromVoiceConnectorRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DisassociatePhoneNumbersFromVoiceConnectorGroupResponse disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest disassociatePhoneNumbersFromVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
disassociatePhoneNumbersFromVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default DisassociatePhoneNumbersFromVoiceConnectorGroupResponse disassociatePhoneNumbersFromVoiceConnectorGroup(Consumer<DisassociatePhoneNumbersFromVoiceConnectorGroupRequest.Builder> disassociatePhoneNumbersFromVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
DisassociatePhoneNumbersFromVoiceConnectorGroupRequest.Builder avoiding the need to create one manually
via DisassociatePhoneNumbersFromVoiceConnectorGroupRequest.builder()
disassociatePhoneNumbersFromVoiceConnectorGroupRequest - A Consumer that will call methods on
DisassociatePhoneNumbersFromVoiceConnectorGroupRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateSigninDelegateGroupsFromAccountResponse disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
disassociateSigninDelegateGroupsFromAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateSigninDelegateGroupsFromAccountResponse disassociateSigninDelegateGroupsFromAccount(Consumer<DisassociateSigninDelegateGroupsFromAccountRequest.Builder> disassociateSigninDelegateGroupsFromAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
This is a convenience which creates an instance of the
DisassociateSigninDelegateGroupsFromAccountRequest.Builder avoiding the need to create one manually via
DisassociateSigninDelegateGroupsFromAccountRequest.builder()
disassociateSigninDelegateGroupsFromAccountRequest - A Consumer that will call methods on
DisassociateSigninDelegateGroupsFromAccountRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountResponse getAccount(GetAccountRequest getAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountResponse getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
This is a convenience which creates an instance of the GetAccountRequest.Builder avoiding the need to
create one manually via GetAccountRequest.builder()
getAccountRequest - A Consumer that will call methods on
GetAccountRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountSettingsResponse getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getAccountSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountSettingsResponse getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetAccountSettingsRequest.Builder avoiding the
need to create one manually via GetAccountSettingsRequest.builder()
getAccountSettingsRequest - A Consumer that will call methods on
GetAccountSettingsRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetAppInstanceRetentionSettingsResponse getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getAppInstanceRetentionSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetAppInstanceRetentionSettingsResponse getAppInstanceRetentionSettings(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetAppInstanceRetentionSettingsRequest.Builder
avoiding the need to create one manually via GetAppInstanceRetentionSettingsRequest.builder()
getAppInstanceRetentionSettingsRequest - A Consumer that will call methods on
GetAppInstanceRetentionSettingsRequest.Builder to
create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetAppInstanceStreamingConfigurationsResponse getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest getAppInstanceStreamingConfigurationsRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getAppInstanceStreamingConfigurationsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetAppInstanceStreamingConfigurationsResponse getAppInstanceStreamingConfigurations(Consumer<GetAppInstanceStreamingConfigurationsRequest.Builder> getAppInstanceStreamingConfigurationsRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
GetAppInstanceStreamingConfigurationsRequest.Builder avoiding the need to create one manually via
GetAppInstanceStreamingConfigurationsRequest.builder()
getAppInstanceStreamingConfigurationsRequest - A Consumer that will call methods on
GetAppInstanceStreamingConfigurationsRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetAttendeeResponse getAttendee(GetAttendeeRequest getAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetAttendeeResponse getAttendee(Consumer<GetAttendeeRequest.Builder> getAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetAttendeeRequest.Builder avoiding the need to
create one manually via GetAttendeeRequest.builder()
getAttendeeRequest - A Consumer that will call methods on
GetAttendeeRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBotResponse getBot(GetBotRequest getBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, NotFoundException, BadRequestException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
getBotRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBotResponse getBot(Consumer<GetBotRequest.Builder> getBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, NotFoundException, BadRequestException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
This is a convenience which creates an instance of the GetBotRequest.Builder avoiding the need to create
one manually via GetBotRequest.builder()
getBotRequest - A Consumer that will call methods on
GetBotRequest.Builder to create a request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetChannelMessageResponse getChannelMessage(GetChannelMessageRequest getChannelMessageRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetChannelMessageResponse getChannelMessage(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetChannelMessageRequest.Builder avoiding the need
to create one manually via GetChannelMessageRequest.builder()
getChannelMessageRequest - A Consumer that will call methods on
GetChannelMessageRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEventsConfigurationResponse getEventsConfiguration(GetEventsConfigurationRequest getEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, AwsServiceException, SdkClientException, ChimeException
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
getEventsConfigurationRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEventsConfigurationResponse getEventsConfiguration(Consumer<GetEventsConfigurationRequest.Builder> getEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, AwsServiceException, SdkClientException, ChimeException
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
This is a convenience which creates an instance of the GetEventsConfigurationRequest.Builder avoiding the
need to create one manually via GetEventsConfigurationRequest.builder()
getEventsConfigurationRequest - A Consumer that will call methods on
GetEventsConfigurationRequest.Builder to create a
request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGlobalSettingsResponse getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
getGlobalSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGlobalSettingsResponse getGlobalSettings(Consumer<GetGlobalSettingsRequest.Builder> getGlobalSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
This is a convenience which creates an instance of the GetGlobalSettingsRequest.Builder avoiding the need
to create one manually via GetGlobalSettingsRequest.builder()
getGlobalSettingsRequest - A Consumer that will call methods on
GetGlobalSettingsRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetMediaCapturePipelineResponse getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest) throws NotFoundException, ForbiddenException, BadRequestException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getMediaCapturePipelineRequest - NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetMediaCapturePipelineResponse getMediaCapturePipeline(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest) throws NotFoundException, ForbiddenException, BadRequestException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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 is a convenience which creates an instance of the GetMediaCapturePipelineRequest.Builder avoiding
the need to create one manually via GetMediaCapturePipelineRequest.builder()
getMediaCapturePipelineRequest - A Consumer that will call methods on
GetMediaCapturePipelineRequest.Builder to create a
request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetMeetingResponse getMeeting(GetMeetingRequest getMeetingRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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 .
getMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetMeetingResponse getMeeting(Consumer<GetMeetingRequest.Builder> getMeetingRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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 .
This is a convenience which creates an instance of the GetMeetingRequest.Builder avoiding the need to
create one manually via GetMeetingRequest.builder()
getMeetingRequest - A Consumer that will call methods on
GetMeetingRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetMessagingSessionEndpointResponse getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest) throws UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getMessagingSessionEndpointRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetMessagingSessionEndpointResponse getMessagingSessionEndpoint(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest) throws UnauthorizedClientException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetMessagingSessionEndpointRequest.Builder
avoiding the need to create one manually via GetMessagingSessionEndpointRequest.builder()
getMessagingSessionEndpointRequest - A Consumer that will call methods on
GetMessagingSessionEndpointRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPhoneNumberResponse getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPhoneNumberResponse getPhoneNumber(Consumer<GetPhoneNumberRequest.Builder> getPhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
This is a convenience which creates an instance of the GetPhoneNumberRequest.Builder avoiding the need to
create one manually via GetPhoneNumberRequest.builder()
getPhoneNumberRequest - A Consumer that will call methods on
GetPhoneNumberRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPhoneNumberOrderResponse getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getPhoneNumberOrderRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPhoneNumberOrderResponse getPhoneNumberOrder(Consumer<GetPhoneNumberOrderRequest.Builder> getPhoneNumberOrderRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetPhoneNumberOrderRequest.Builder avoiding the
need to create one manually via GetPhoneNumberOrderRequest.builder()
getPhoneNumberOrderRequest - A Consumer that will call methods on
GetPhoneNumberOrderRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPhoneNumberSettingsResponse getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getPhoneNumberSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPhoneNumberSettingsResponse getPhoneNumberSettings(Consumer<GetPhoneNumberSettingsRequest.Builder> getPhoneNumberSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
This is a convenience which creates an instance of the GetPhoneNumberSettingsRequest.Builder avoiding the
need to create one manually via GetPhoneNumberSettingsRequest.builder()
getPhoneNumberSettingsRequest - A Consumer that will call methods on
GetPhoneNumberSettingsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetProxySessionResponse getProxySession(GetProxySessionRequest getProxySessionRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getProxySessionRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetProxySessionResponse getProxySession(Consumer<GetProxySessionRequest.Builder> getProxySessionRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetProxySessionRequest.Builder avoiding the need
to create one manually via GetProxySessionRequest.builder()
getProxySessionRequest - A Consumer that will call methods on
GetProxySessionRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRetentionSettingsResponse getRetentionSettings(GetRetentionSettingsRequest getRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getRetentionSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRetentionSettingsResponse getRetentionSettings(Consumer<GetRetentionSettingsRequest.Builder> getRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetRetentionSettingsRequest.Builder avoiding the
need to create one manually via GetRetentionSettingsRequest.builder()
getRetentionSettingsRequest - A Consumer that will call methods on
GetRetentionSettingsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRoomResponse getRoom(GetRoomRequest getRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
getRoomRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRoomResponse getRoom(Consumer<GetRoomRequest.Builder> getRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the GetRoomRequest.Builder avoiding the need to create
one manually via GetRoomRequest.builder()
getRoomRequest - A Consumer that will call methods on
GetRoomRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetSipMediaApplicationResponse getSipMediaApplication(GetSipMediaApplicationRequest getSipMediaApplicationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getSipMediaApplicationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetSipMediaApplicationResponse getSipMediaApplication(Consumer<GetSipMediaApplicationRequest.Builder> getSipMediaApplicationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetSipMediaApplicationRequest.Builder avoiding the
need to create one manually via GetSipMediaApplicationRequest.builder()
getSipMediaApplicationRequest - A Consumer that will call methods on
GetSipMediaApplicationRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetSipMediaApplicationLoggingConfigurationResponse getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest getSipMediaApplicationLoggingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getSipMediaApplicationLoggingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetSipMediaApplicationLoggingConfigurationResponse getSipMediaApplicationLoggingConfiguration(Consumer<GetSipMediaApplicationLoggingConfigurationRequest.Builder> getSipMediaApplicationLoggingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
GetSipMediaApplicationLoggingConfigurationRequest.Builder avoiding the need to create one manually via
GetSipMediaApplicationLoggingConfigurationRequest.builder()
getSipMediaApplicationLoggingConfigurationRequest - A Consumer that will call methods on
GetSipMediaApplicationLoggingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetSipRuleResponse getSipRule(GetSipRuleRequest getSipRuleRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getSipRuleRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetSipRuleResponse getSipRule(Consumer<GetSipRuleRequest.Builder> getSipRuleRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetSipRuleRequest.Builder avoiding the need to
create one manually via GetSipRuleRequest.builder()
getSipRuleRequest - A Consumer that will call methods on
GetSipRuleRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUserResponse getUser(GetUserRequest getUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetUserRequest.Builder avoiding the need to create
one manually via GetUserRequest.builder()
getUserRequest - A Consumer that will call methods on
GetUserRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUserSettingsResponse getUserSettings(GetUserSettingsRequest getUserSettingsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves settings for the specified user ID, such as any associated phone number settings.
getUserSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUserSettingsResponse getUserSettings(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Retrieves settings for the specified user ID, such as any associated phone number settings.
This is a convenience which creates an instance of the GetUserSettingsRequest.Builder avoiding the need
to create one manually via GetUserSettingsRequest.builder()
getUserSettingsRequest - A Consumer that will call methods on
GetUserSettingsRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorResponse getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorResponse getVoiceConnector(Consumer<GetVoiceConnectorRequest.Builder> getVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetVoiceConnectorRequest.Builder avoiding the need
to create one manually via GetVoiceConnectorRequest.builder()
getVoiceConnectorRequest - A Consumer that will call methods on
GetVoiceConnectorRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorEmergencyCallingConfigurationResponse getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest getVoiceConnectorEmergencyCallingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorEmergencyCallingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorEmergencyCallingConfigurationResponse getVoiceConnectorEmergencyCallingConfiguration(Consumer<GetVoiceConnectorEmergencyCallingConfigurationRequest.Builder> getVoiceConnectorEmergencyCallingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
GetVoiceConnectorEmergencyCallingConfigurationRequest.Builder avoiding the need to create one manually
via GetVoiceConnectorEmergencyCallingConfigurationRequest.builder()
getVoiceConnectorEmergencyCallingConfigurationRequest - A Consumer that will call methods on
GetVoiceConnectorEmergencyCallingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorGroupResponse getVoiceConnectorGroup(GetVoiceConnectorGroupRequest getVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorGroupResponse getVoiceConnectorGroup(Consumer<GetVoiceConnectorGroupRequest.Builder> getVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetVoiceConnectorGroupRequest.Builder avoiding the
need to create one manually via GetVoiceConnectorGroupRequest.builder()
getVoiceConnectorGroupRequest - A Consumer that will call methods on
GetVoiceConnectorGroupRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorLoggingConfigurationResponse getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest getVoiceConnectorLoggingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorLoggingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorLoggingConfigurationResponse getVoiceConnectorLoggingConfiguration(Consumer<GetVoiceConnectorLoggingConfigurationRequest.Builder> getVoiceConnectorLoggingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
GetVoiceConnectorLoggingConfigurationRequest.Builder avoiding the need to create one manually via
GetVoiceConnectorLoggingConfigurationRequest.builder()
getVoiceConnectorLoggingConfigurationRequest - A Consumer that will call methods on
GetVoiceConnectorLoggingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorOriginationResponse getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorOriginationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorOriginationResponse getVoiceConnectorOrigination(Consumer<GetVoiceConnectorOriginationRequest.Builder> getVoiceConnectorOriginationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetVoiceConnectorOriginationRequest.Builder
avoiding the need to create one manually via GetVoiceConnectorOriginationRequest.builder()
getVoiceConnectorOriginationRequest - A Consumer that will call methods on
GetVoiceConnectorOriginationRequest.Builder to create
a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorProxyResponse getVoiceConnectorProxy(GetVoiceConnectorProxyRequest getVoiceConnectorProxyRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorProxyRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorProxyResponse getVoiceConnectorProxy(Consumer<GetVoiceConnectorProxyRequest.Builder> getVoiceConnectorProxyRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetVoiceConnectorProxyRequest.Builder avoiding the
need to create one manually via GetVoiceConnectorProxyRequest.builder()
getVoiceConnectorProxyRequest - A Consumer that will call methods on
GetVoiceConnectorProxyRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorStreamingConfigurationResponse getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest getVoiceConnectorStreamingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorStreamingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorStreamingConfigurationResponse getVoiceConnectorStreamingConfiguration(Consumer<GetVoiceConnectorStreamingConfigurationRequest.Builder> getVoiceConnectorStreamingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
GetVoiceConnectorStreamingConfigurationRequest.Builder avoiding the need to create one manually via
GetVoiceConnectorStreamingConfigurationRequest.builder()
getVoiceConnectorStreamingConfigurationRequest - A Consumer that will call methods on
GetVoiceConnectorStreamingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorTerminationResponse getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorTerminationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorTerminationResponse getVoiceConnectorTermination(Consumer<GetVoiceConnectorTerminationRequest.Builder> getVoiceConnectorTerminationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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 is a convenience which creates an instance of the GetVoiceConnectorTerminationRequest.Builder
avoiding the need to create one manually via GetVoiceConnectorTerminationRequest.builder()
getVoiceConnectorTerminationRequest - A Consumer that will call methods on
GetVoiceConnectorTerminationRequest.Builder to create
a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorTerminationHealthResponse getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
getVoiceConnectorTerminationHealthRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default GetVoiceConnectorTerminationHealthResponse getVoiceConnectorTerminationHealth(Consumer<GetVoiceConnectorTerminationHealthRequest.Builder> getVoiceConnectorTerminationHealthRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the GetVoiceConnectorTerminationHealthRequest.Builder
avoiding the need to create one manually via GetVoiceConnectorTerminationHealthRequest.builder()
getVoiceConnectorTerminationHealthRequest - A Consumer that will call methods on
GetVoiceConnectorTerminationHealthRequest.Builder to
create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault InviteUsersResponse inviteUsers(InviteUsersRequest inviteUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
inviteUsersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault InviteUsersResponse inviteUsers(Consumer<InviteUsersRequest.Builder> inviteUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the InviteUsersRequest.Builder avoiding the need to
create one manually via InviteUsersRequest.builder()
inviteUsersRequest - A Consumer that will call methods on
InviteUsersRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccountsResponse listAccounts(ListAccountsRequest listAccountsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listAccountsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccountsResponse listAccounts(Consumer<ListAccountsRequest.Builder> listAccountsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListAccountsRequest.Builder avoiding the need to
create one manually via ListAccountsRequest.builder()
listAccountsRequest - A Consumer that will call methods on
ListAccountsRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccountsResponse listAccounts() throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistAccounts(ListAccountsRequest),
AWS API
Documentationdefault ListAccountsIterable listAccountsPaginator() throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAccountsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest) operation.
UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistAccountsPaginator(ListAccountsRequest),
AWS API
Documentationdefault ListAccountsIterable listAccountsPaginator(ListAccountsRequest listAccountsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAccountsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest) operation.
listAccountsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccountsIterable listAccountsPaginator(Consumer<ListAccountsRequest.Builder> listAccountsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAccountsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAccountsIterable responses = client.listAccountsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest) operation.
This is a convenience which creates an instance of the ListAccountsRequest.Builder avoiding the need to
create one manually via ListAccountsRequest.builder()
listAccountsRequest - A Consumer that will call methods on
ListAccountsRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstanceAdminsResponse listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listAppInstanceAdminsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstanceAdminsResponse listAppInstanceAdmins(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListAppInstanceAdminsRequest.Builder avoiding the
need to create one manually via ListAppInstanceAdminsRequest.builder()
listAppInstanceAdminsRequest - A Consumer that will call methods on
ListAppInstanceAdminsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstanceAdminsIterable listAppInstanceAdminsPaginator(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listAppInstanceAdmins(software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsIterable responses = client
.listAppInstanceAdminsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceAdmins(software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsRequest)
operation.
listAppInstanceAdminsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstanceAdminsIterable listAppInstanceAdminsPaginator(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listAppInstanceAdmins(software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsIterable responses = client
.listAppInstanceAdminsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsIterable responses = client.listAppInstanceAdminsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceAdmins(software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsRequest)
operation.
This is a convenience which creates an instance of the ListAppInstanceAdminsRequest.Builder avoiding the
need to create one manually via ListAppInstanceAdminsRequest.builder()
listAppInstanceAdminsRequest - A Consumer that will call methods on
ListAppInstanceAdminsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstanceUsersResponse listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listAppInstanceUsersRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstanceUsersResponse listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListAppInstanceUsersRequest.Builder avoiding the
need to create one manually via ListAppInstanceUsersRequest.builder()
listAppInstanceUsersRequest - A Consumer that will call methods on
ListAppInstanceUsersRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstanceUsersIterable listAppInstanceUsersPaginator(ListAppInstanceUsersRequest listAppInstanceUsersRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listAppInstanceUsers(software.amazon.awssdk.services.chime.model.ListAppInstanceUsersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersIterable responses = client
.listAppInstanceUsersPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAppInstanceUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUsers(software.amazon.awssdk.services.chime.model.ListAppInstanceUsersRequest)
operation.
listAppInstanceUsersRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstanceUsersIterable listAppInstanceUsersPaginator(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listAppInstanceUsers(software.amazon.awssdk.services.chime.model.ListAppInstanceUsersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersIterable responses = client
.listAppInstanceUsersPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAppInstanceUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersIterable responses = client.listAppInstanceUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstanceUsers(software.amazon.awssdk.services.chime.model.ListAppInstanceUsersRequest)
operation.
This is a convenience which creates an instance of the ListAppInstanceUsersRequest.Builder avoiding the
need to create one manually via ListAppInstanceUsersRequest.builder()
listAppInstanceUsersRequest - A Consumer that will call methods on
ListAppInstanceUsersRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstancesResponse listAppInstances(ListAppInstancesRequest listAppInstancesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists all Amazon Chime AppInstances 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.
listAppInstancesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstancesResponse listAppInstances(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists all Amazon Chime AppInstances 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.
This is a convenience which creates an instance of the ListAppInstancesRequest.Builder avoiding the need
to create one manually via ListAppInstancesRequest.builder()
listAppInstancesRequest - A Consumer that will call methods on
ListAppInstancesRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstancesIterable listAppInstancesPaginator(ListAppInstancesRequest listAppInstancesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists all Amazon Chime AppInstances 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.
This is a variant of
listAppInstances(software.amazon.awssdk.services.chime.model.ListAppInstancesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAppInstancesIterable responses = client
.listAppInstancesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAppInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstances(software.amazon.awssdk.services.chime.model.ListAppInstancesRequest) operation.
listAppInstancesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAppInstancesIterable listAppInstancesPaginator(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists all Amazon Chime AppInstances 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.
This is a variant of
listAppInstances(software.amazon.awssdk.services.chime.model.ListAppInstancesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAppInstancesIterable responses = client
.listAppInstancesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAppInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAppInstancesIterable responses = client.listAppInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppInstances(software.amazon.awssdk.services.chime.model.ListAppInstancesRequest) operation.
This is a convenience which creates an instance of the ListAppInstancesRequest.Builder avoiding the need
to create one manually via ListAppInstancesRequest.builder()
listAppInstancesRequest - A Consumer that will call methods on
ListAppInstancesRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAttendeeTagsResponse listAttendeeTags(ListAttendeeTagsRequest listAttendeeTagsRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listAttendeeTagsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAttendeeTagsResponse listAttendeeTags(Consumer<ListAttendeeTagsRequest.Builder> listAttendeeTagsRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListAttendeeTagsRequest.Builder avoiding the need
to create one manually via ListAttendeeTagsRequest.builder()
listAttendeeTagsRequest - A Consumer that will call methods on
ListAttendeeTagsRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAttendeesResponse listAttendees(ListAttendeesRequest listAttendeesRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listAttendeesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAttendeesResponse listAttendees(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListAttendeesRequest.Builder avoiding the need to
create one manually via ListAttendeesRequest.builder()
listAttendeesRequest - A Consumer that will call methods on
ListAttendeesRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAttendeesIterable listAttendeesPaginator(ListAttendeesRequest listAttendeesRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listAttendees(software.amazon.awssdk.services.chime.model.ListAttendeesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAttendeesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttendees(software.amazon.awssdk.services.chime.model.ListAttendeesRequest) operation.
listAttendeesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListAttendeesIterable listAttendeesPaginator(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listAttendees(software.amazon.awssdk.services.chime.model.ListAttendeesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListAttendeesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttendees(software.amazon.awssdk.services.chime.model.ListAttendeesRequest) operation.
This is a convenience which creates an instance of the ListAttendeesRequest.Builder avoiding the need to
create one manually via ListAttendeesRequest.builder()
listAttendeesRequest - A Consumer that will call methods on
ListAttendeesRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBotsResponse listBots(ListBotsRequest listBotsRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, BadRequestException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
listBotsRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBotsResponse listBots(Consumer<ListBotsRequest.Builder> listBotsRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, BadRequestException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
This is a convenience which creates an instance of the ListBotsRequest.Builder avoiding the need to
create one manually via ListBotsRequest.builder()
listBotsRequest - A Consumer that will call methods on
ListBotsRequest.Builder to create a request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBotsIterable listBotsPaginator(ListBotsRequest listBotsRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, BadRequestException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
This is a variant of listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListBotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest) operation.
listBotsRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBotsIterable listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, UnauthorizedClientException, BadRequestException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
This is a variant of listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListBotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListBotsIterable responses = client.listBotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest) operation.
This is a convenience which creates an instance of the ListBotsRequest.Builder avoiding the need to
create one manually via ListBotsRequest.builder()
listBotsRequest - A Consumer that will call methods on
ListBotsRequest.Builder to create a request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelBansResponse listChannelBans(ListChannelBansRequest listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listChannelBansRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelBansResponse listChannelBans(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListChannelBansRequest.Builder avoiding the need
to create one manually via ListChannelBansRequest.builder()
listChannelBansRequest - A Consumer that will call methods on
ListChannelBansRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelBansIterable listChannelBansPaginator(ListChannelBansRequest listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listChannelBans(software.amazon.awssdk.services.chime.model.ListChannelBansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelBansResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelBans(software.amazon.awssdk.services.chime.model.ListChannelBansRequest) operation.
listChannelBansRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelBansIterable listChannelBansPaginator(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listChannelBans(software.amazon.awssdk.services.chime.model.ListChannelBansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelBansResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelBansIterable responses = client.listChannelBansPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelBans(software.amazon.awssdk.services.chime.model.ListChannelBansRequest) operation.
This is a convenience which creates an instance of the ListChannelBansRequest.Builder avoiding the need
to create one manually via ListChannelBansRequest.builder()
listChannelBansRequest - A Consumer that will call methods on
ListChannelBansRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMembershipsResponse listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listChannelMembershipsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMembershipsResponse listChannelMemberships(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListChannelMembershipsRequest.Builder avoiding the
need to create one manually via ListChannelMembershipsRequest.builder()
listChannelMembershipsRequest - A Consumer that will call methods on
ListChannelMembershipsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMembershipsIterable listChannelMembershipsPaginator(ListChannelMembershipsRequest listChannelMembershipsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelMemberships(software.amazon.awssdk.services.chime.model.ListChannelMembershipsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsIterable responses = client
.listChannelMembershipsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelMembershipsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMemberships(software.amazon.awssdk.services.chime.model.ListChannelMembershipsRequest)
operation.
listChannelMembershipsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMembershipsIterable listChannelMembershipsPaginator(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelMemberships(software.amazon.awssdk.services.chime.model.ListChannelMembershipsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsIterable responses = client
.listChannelMembershipsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelMembershipsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsIterable responses = client.listChannelMembershipsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMemberships(software.amazon.awssdk.services.chime.model.ListChannelMembershipsRequest)
operation.
This is a convenience which creates an instance of the ListChannelMembershipsRequest.Builder avoiding the
need to create one manually via ListChannelMembershipsRequest.builder()
listChannelMembershipsRequest - A Consumer that will call methods on
ListChannelMembershipsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMembershipsForAppInstanceUserResponse listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listChannelMembershipsForAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMembershipsForAppInstanceUserResponse listChannelMembershipsForAppInstanceUser(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
ListChannelMembershipsForAppInstanceUserRequest.Builder avoiding the need to create one manually via
ListChannelMembershipsForAppInstanceUserRequest.builder()
listChannelMembershipsForAppInstanceUserRequest - A Consumer that will call methods on
ListChannelMembershipsForAppInstanceUserRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMembershipsForAppInstanceUserIterable listChannelMembershipsForAppInstanceUserPaginator(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client
.listChannelMembershipsForAppInstanceUserPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserRequest)
operation.
listChannelMembershipsForAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMembershipsForAppInstanceUserIterable listChannelMembershipsForAppInstanceUserPaginator(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client
.listChannelMembershipsForAppInstanceUserPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserIterable responses = client.listChannelMembershipsForAppInstanceUserPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserRequest)
operation.
This is a convenience which creates an instance of the
ListChannelMembershipsForAppInstanceUserRequest.Builder avoiding the need to create one manually via
ListChannelMembershipsForAppInstanceUserRequest.builder()
listChannelMembershipsForAppInstanceUserRequest - A Consumer that will call methods on
ListChannelMembershipsForAppInstanceUserRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMessagesResponse listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listChannelMessagesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMessagesResponse listChannelMessages(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListChannelMessagesRequest.Builder avoiding the
need to create one manually via ListChannelMessagesRequest.builder()
listChannelMessagesRequest - A Consumer that will call methods on
ListChannelMessagesRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMessagesIterable listChannelMessagesPaginator(ListChannelMessagesRequest listChannelMessagesRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelMessages(software.amazon.awssdk.services.chime.model.ListChannelMessagesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelMessagesIterable responses = client
.listChannelMessagesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelMessagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMessages(software.amazon.awssdk.services.chime.model.ListChannelMessagesRequest)
operation.
listChannelMessagesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelMessagesIterable listChannelMessagesPaginator(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelMessages(software.amazon.awssdk.services.chime.model.ListChannelMessagesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelMessagesIterable responses = client
.listChannelMessagesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelMessagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelMessagesIterable responses = client.listChannelMessagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelMessages(software.amazon.awssdk.services.chime.model.ListChannelMessagesRequest)
operation.
This is a convenience which creates an instance of the ListChannelMessagesRequest.Builder avoiding the
need to create one manually via ListChannelMessagesRequest.builder()
listChannelMessagesRequest - A Consumer that will call methods on
ListChannelMessagesRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelModeratorsResponse listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listChannelModeratorsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelModeratorsResponse listChannelModerators(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListChannelModeratorsRequest.Builder avoiding the
need to create one manually via ListChannelModeratorsRequest.builder()
listChannelModeratorsRequest - A Consumer that will call methods on
ListChannelModeratorsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelModeratorsIterable listChannelModeratorsPaginator(ListChannelModeratorsRequest listChannelModeratorsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelModerators(software.amazon.awssdk.services.chime.model.ListChannelModeratorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelModeratorsIterable responses = client
.listChannelModeratorsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelModeratorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelModerators(software.amazon.awssdk.services.chime.model.ListChannelModeratorsRequest)
operation.
listChannelModeratorsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelModeratorsIterable listChannelModeratorsPaginator(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelModerators(software.amazon.awssdk.services.chime.model.ListChannelModeratorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelModeratorsIterable responses = client
.listChannelModeratorsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelModeratorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelModeratorsIterable responses = client.listChannelModeratorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelModerators(software.amazon.awssdk.services.chime.model.ListChannelModeratorsRequest)
operation.
This is a convenience which creates an instance of the ListChannelModeratorsRequest.Builder avoiding the
need to create one manually via ListChannelModeratorsRequest.builder()
listChannelModeratorsRequest - A Consumer that will call methods on
ListChannelModeratorsRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelsResponse listChannels(ListChannelsRequest listChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listChannelsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelsResponse listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on
ListChannelsRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelsIterable listChannelsPaginator(ListChannelsRequest listChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listChannels(software.amazon.awssdk.services.chime.model.ListChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.chime.model.ListChannelsRequest) operation.
listChannelsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelsIterable listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listChannels(software.amazon.awssdk.services.chime.model.ListChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.chime.model.ListChannelsRequest) operation.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on
ListChannelsRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelsModeratedByAppInstanceUserResponse listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listChannelsModeratedByAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelsModeratedByAppInstanceUserResponse listChannelsModeratedByAppInstanceUser(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
ListChannelsModeratedByAppInstanceUserRequest.Builder avoiding the need to create one manually via
ListChannelsModeratedByAppInstanceUserRequest.builder()
listChannelsModeratedByAppInstanceUserRequest - A Consumer that will call methods on
ListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelsModeratedByAppInstanceUserIterable listChannelsModeratedByAppInstanceUserPaginator(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client
.listChannelsModeratedByAppInstanceUserPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserRequest)
operation.
listChannelsModeratedByAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListChannelsModeratedByAppInstanceUserIterable listChannelsModeratedByAppInstanceUserPaginator(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client
.listChannelsModeratedByAppInstanceUserPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserIterable responses = client.listChannelsModeratedByAppInstanceUserPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserRequest)
operation.
This is a convenience which creates an instance of the
ListChannelsModeratedByAppInstanceUserRequest.Builder avoiding the need to create one manually via
ListChannelsModeratedByAppInstanceUserRequest.builder()
listChannelsModeratedByAppInstanceUserRequest - A Consumer that will call methods on
ListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMediaCapturePipelinesResponse listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listMediaCapturePipelinesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMediaCapturePipelinesResponse listMediaCapturePipelines(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListMediaCapturePipelinesRequest.Builder avoiding
the need to create one manually via ListMediaCapturePipelinesRequest.builder()
listMediaCapturePipelinesRequest - A Consumer that will call methods on
ListMediaCapturePipelinesRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMediaCapturePipelinesIterable listMediaCapturePipelinesPaginator(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listMediaCapturePipelines(software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesIterable responses = client.listMediaCapturePipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesIterable responses = client
.listMediaCapturePipelinesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesIterable responses = client.listMediaCapturePipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaCapturePipelines(software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesRequest)
operation.
listMediaCapturePipelinesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMediaCapturePipelinesIterable listMediaCapturePipelinesPaginator(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listMediaCapturePipelines(software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesIterable responses = client.listMediaCapturePipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesIterable responses = client
.listMediaCapturePipelinesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesIterable responses = client.listMediaCapturePipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaCapturePipelines(software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesRequest)
operation.
This is a convenience which creates an instance of the ListMediaCapturePipelinesRequest.Builder avoiding
the need to create one manually via ListMediaCapturePipelinesRequest.builder()
listMediaCapturePipelinesRequest - A Consumer that will call methods on
ListMediaCapturePipelinesRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMeetingTagsResponse listMeetingTags(ListMeetingTagsRequest listMeetingTagsRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listMeetingTagsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMeetingTagsResponse listMeetingTags(Consumer<ListMeetingTagsRequest.Builder> listMeetingTagsRequest) throws BadRequestException, ForbiddenException, NotFoundException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListMeetingTagsRequest.Builder avoiding the need
to create one manually via ListMeetingTagsRequest.builder()
listMeetingTagsRequest - A Consumer that will call methods on
ListMeetingTagsRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMeetingsResponse listMeetings(ListMeetingsRequest listMeetingsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listMeetingsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMeetingsResponse listMeetings(Consumer<ListMeetingsRequest.Builder> listMeetingsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListMeetingsRequest.Builder avoiding the need to
create one manually via ListMeetingsRequest.builder()
listMeetingsRequest - A Consumer that will call methods on
ListMeetingsRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMeetingsIterable listMeetingsPaginator(ListMeetingsRequest listMeetingsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listMeetings(software.amazon.awssdk.services.chime.model.ListMeetingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListMeetingsIterable responses = client.listMeetingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListMeetingsIterable responses = client.listMeetingsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListMeetingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListMeetingsIterable responses = client.listMeetingsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMeetings(software.amazon.awssdk.services.chime.model.ListMeetingsRequest) operation.
listMeetingsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListMeetingsIterable listMeetingsPaginator(Consumer<ListMeetingsRequest.Builder> listMeetingsRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listMeetings(software.amazon.awssdk.services.chime.model.ListMeetingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListMeetingsIterable responses = client.listMeetingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListMeetingsIterable responses = client.listMeetingsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListMeetingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListMeetingsIterable responses = client.listMeetingsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMeetings(software.amazon.awssdk.services.chime.model.ListMeetingsRequest) operation.
This is a convenience which creates an instance of the ListMeetingsRequest.Builder avoiding the need to
create one manually via ListMeetingsRequest.builder()
listMeetingsRequest - A Consumer that will call methods on
ListMeetingsRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPhoneNumberOrdersResponse listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumberOrdersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPhoneNumberOrdersResponse listPhoneNumberOrders(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the phone number orders for the administrator's Amazon Chime account.
This is a convenience which creates an instance of the ListPhoneNumberOrdersRequest.Builder avoiding the
need to create one manually via ListPhoneNumberOrdersRequest.builder()
listPhoneNumberOrdersRequest - A Consumer that will call methods on
ListPhoneNumberOrdersRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPhoneNumberOrdersIterable listPhoneNumberOrdersPaginator(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the phone number orders for the administrator's Amazon Chime account.
This is a variant of
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client.listPhoneNumberOrdersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client
.listPhoneNumberOrdersPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client.listPhoneNumberOrdersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)
operation.
listPhoneNumberOrdersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPhoneNumberOrdersIterable listPhoneNumberOrdersPaginator(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the phone number orders for the administrator's Amazon Chime account.
This is a variant of
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client.listPhoneNumberOrdersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client
.listPhoneNumberOrdersPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersIterable responses = client.listPhoneNumberOrdersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)
operation.
This is a convenience which creates an instance of the ListPhoneNumberOrdersRequest.Builder avoiding the
need to create one manually via ListPhoneNumberOrdersRequest.builder()
listPhoneNumberOrdersRequest - A Consumer that will call methods on
ListPhoneNumberOrdersRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPhoneNumbersResponse listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, NotFoundException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
listPhoneNumbersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPhoneNumbersResponse listPhoneNumbers(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, NotFoundException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
This is a convenience which creates an instance of the ListPhoneNumbersRequest.Builder avoiding the need
to create one manually via ListPhoneNumbersRequest.builder()
listPhoneNumbersRequest - A Consumer that will call methods on
ListPhoneNumbersRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPhoneNumbersIterable listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, NotFoundException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
This is a variant of
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client
.listPhoneNumbersPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest) operation.
listPhoneNumbersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPhoneNumbersIterable listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, NotFoundException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
This is a variant of
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client
.listPhoneNumbersPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersIterable responses = client.listPhoneNumbersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest) operation.
This is a convenience which creates an instance of the ListPhoneNumbersRequest.Builder avoiding the need
to create one manually via ListPhoneNumbersRequest.builder()
listPhoneNumbersRequest - A Consumer that will call methods on
ListPhoneNumbersRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListProxySessionsResponse listProxySessions(ListProxySessionsRequest listProxySessionsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listProxySessionsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListProxySessionsResponse listProxySessions(Consumer<ListProxySessionsRequest.Builder> listProxySessionsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListProxySessionsRequest.Builder avoiding the need
to create one manually via ListProxySessionsRequest.builder()
listProxySessionsRequest - A Consumer that will call methods on
ListProxySessionsRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListProxySessionsIterable listProxySessionsPaginator(ListProxySessionsRequest listProxySessionsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listProxySessions(software.amazon.awssdk.services.chime.model.ListProxySessionsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListProxySessionsIterable responses = client.listProxySessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListProxySessionsIterable responses = client
.listProxySessionsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListProxySessionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListProxySessionsIterable responses = client.listProxySessionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProxySessions(software.amazon.awssdk.services.chime.model.ListProxySessionsRequest) operation.
listProxySessionsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListProxySessionsIterable listProxySessionsPaginator(Consumer<ListProxySessionsRequest.Builder> listProxySessionsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listProxySessions(software.amazon.awssdk.services.chime.model.ListProxySessionsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListProxySessionsIterable responses = client.listProxySessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListProxySessionsIterable responses = client
.listProxySessionsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListProxySessionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListProxySessionsIterable responses = client.listProxySessionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProxySessions(software.amazon.awssdk.services.chime.model.ListProxySessionsRequest) operation.
This is a convenience which creates an instance of the ListProxySessionsRequest.Builder avoiding the need
to create one manually via ListProxySessionsRequest.builder()
listProxySessionsRequest - A Consumer that will call methods on
ListProxySessionsRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoomMembershipsResponse listRoomMemberships(ListRoomMembershipsRequest listRoomMembershipsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
listRoomMembershipsRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoomMembershipsResponse listRoomMemberships(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
This is a convenience which creates an instance of the ListRoomMembershipsRequest.Builder avoiding the
need to create one manually via ListRoomMembershipsRequest.builder()
listRoomMembershipsRequest - A Consumer that will call methods on
ListRoomMembershipsRequest.Builder to create a
request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoomMembershipsIterable listRoomMembershipsPaginator(ListRoomMembershipsRequest listRoomMembershipsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
This is a variant of
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client.listRoomMembershipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client
.listRoomMembershipsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client.listRoomMembershipsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)
operation.
listRoomMembershipsRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoomMembershipsIterable listRoomMembershipsPaginator(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
This is a variant of
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client.listRoomMembershipsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client
.listRoomMembershipsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsIterable responses = client.listRoomMembershipsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)
operation.
This is a convenience which creates an instance of the ListRoomMembershipsRequest.Builder avoiding the
need to create one manually via ListRoomMembershipsRequest.builder()
listRoomMembershipsRequest - A Consumer that will call methods on
ListRoomMembershipsRequest.Builder to create a
request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoomsResponse listRooms(ListRoomsRequest listRoomsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listRoomsRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoomsResponse listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListRoomsRequest.Builder avoiding the need to
create one manually via ListRoomsRequest.builder()
listRoomsRequest - A Consumer that will call methods on
ListRoomsRequest.Builder to create a request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoomsIterable listRoomsPaginator(ListRoomsRequest listRoomsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListRoomsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest) operation.
listRoomsRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRoomsIterable listRoomsPaginator(Consumer<ListRoomsRequest.Builder> listRoomsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListRoomsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListRoomsIterable responses = client.listRoomsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest) operation.
This is a convenience which creates an instance of the ListRoomsRequest.Builder avoiding the need to
create one manually via ListRoomsRequest.builder()
listRoomsRequest - A Consumer that will call methods on
ListRoomsRequest.Builder to create a request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListSipMediaApplicationsResponse listSipMediaApplications(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listSipMediaApplicationsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListSipMediaApplicationsResponse listSipMediaApplications(Consumer<ListSipMediaApplicationsRequest.Builder> listSipMediaApplicationsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListSipMediaApplicationsRequest.Builder avoiding
the need to create one manually via ListSipMediaApplicationsRequest.builder()
listSipMediaApplicationsRequest - A Consumer that will call methods on
ListSipMediaApplicationsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListSipMediaApplicationsIterable listSipMediaApplicationsPaginator(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listSipMediaApplications(software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsIterable responses = client.listSipMediaApplicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsIterable responses = client
.listSipMediaApplicationsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsIterable responses = client.listSipMediaApplicationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSipMediaApplications(software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsRequest)
operation.
listSipMediaApplicationsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListSipMediaApplicationsIterable listSipMediaApplicationsPaginator(Consumer<ListSipMediaApplicationsRequest.Builder> listSipMediaApplicationsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listSipMediaApplications(software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsIterable responses = client.listSipMediaApplicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsIterable responses = client
.listSipMediaApplicationsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsIterable responses = client.listSipMediaApplicationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSipMediaApplications(software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsRequest)
operation.
This is a convenience which creates an instance of the ListSipMediaApplicationsRequest.Builder avoiding
the need to create one manually via ListSipMediaApplicationsRequest.builder()
listSipMediaApplicationsRequest - A Consumer that will call methods on
ListSipMediaApplicationsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListSipRulesResponse listSipRules(ListSipRulesRequest listSipRulesRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listSipRulesRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListSipRulesResponse listSipRules(Consumer<ListSipRulesRequest.Builder> listSipRulesRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListSipRulesRequest.Builder avoiding the need to
create one manually via ListSipRulesRequest.builder()
listSipRulesRequest - A Consumer that will call methods on
ListSipRulesRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListSipRulesIterable listSipRulesPaginator(ListSipRulesRequest listSipRulesRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listSipRules(software.amazon.awssdk.services.chime.model.ListSipRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListSipRulesIterable responses = client.listSipRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListSipRulesIterable responses = client.listSipRulesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListSipRulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListSipRulesIterable responses = client.listSipRulesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSipRules(software.amazon.awssdk.services.chime.model.ListSipRulesRequest) operation.
listSipRulesRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListSipRulesIterable listSipRulesPaginator(Consumer<ListSipRulesRequest.Builder> listSipRulesRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listSipRules(software.amazon.awssdk.services.chime.model.ListSipRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListSipRulesIterable responses = client.listSipRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListSipRulesIterable responses = client.listSipRulesPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListSipRulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListSipRulesIterable responses = client.listSipRulesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSipRules(software.amazon.awssdk.services.chime.model.ListSipRulesRequest) operation.
This is a convenience which creates an instance of the ListSipRulesRequest.Builder avoiding the need to
create one manually via ListSipRulesRequest.builder()
listSipRulesRequest - A Consumer that will call methods on
ListSipRulesRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSupportedPhoneNumberCountriesResponse listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists supported phone number countries.
listSupportedPhoneNumberCountriesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSupportedPhoneNumberCountriesResponse listSupportedPhoneNumberCountries(Consumer<ListSupportedPhoneNumberCountriesRequest.Builder> listSupportedPhoneNumberCountriesRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Lists supported phone number countries.
This is a convenience which creates an instance of the ListSupportedPhoneNumberCountriesRequest.Builder
avoiding the need to create one manually via ListSupportedPhoneNumberCountriesRequest.builder()
listSupportedPhoneNumberCountriesRequest - A Consumer that will call methods on
ListSupportedPhoneNumberCountriesRequest.Builder to
create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listTagsForResourceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listUsersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on
ListUsersRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest) operation.
listUsersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListUsersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest) operation.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on
ListUsersRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorGroupsResponse listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listVoiceConnectorGroupsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorGroupsResponse listVoiceConnectorGroups(Consumer<ListVoiceConnectorGroupsRequest.Builder> listVoiceConnectorGroupsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListVoiceConnectorGroupsRequest.Builder avoiding
the need to create one manually via ListVoiceConnectorGroupsRequest.builder()
listVoiceConnectorGroupsRequest - A Consumer that will call methods on
ListVoiceConnectorGroupsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorGroupsIterable listVoiceConnectorGroupsPaginator(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listVoiceConnectorGroups(software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsIterable responses = client.listVoiceConnectorGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsIterable responses = client
.listVoiceConnectorGroupsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsIterable responses = client.listVoiceConnectorGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVoiceConnectorGroups(software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsRequest)
operation.
listVoiceConnectorGroupsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorGroupsIterable listVoiceConnectorGroupsPaginator(Consumer<ListVoiceConnectorGroupsRequest.Builder> listVoiceConnectorGroupsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listVoiceConnectorGroups(software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsIterable responses = client.listVoiceConnectorGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsIterable responses = client
.listVoiceConnectorGroupsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsIterable responses = client.listVoiceConnectorGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVoiceConnectorGroups(software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsRequest)
operation.
This is a convenience which creates an instance of the ListVoiceConnectorGroupsRequest.Builder avoiding
the need to create one manually via ListVoiceConnectorGroupsRequest.builder()
listVoiceConnectorGroupsRequest - A Consumer that will call methods on
ListVoiceConnectorGroupsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorTerminationCredentialsResponse listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listVoiceConnectorTerminationCredentialsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorTerminationCredentialsResponse listVoiceConnectorTerminationCredentials(Consumer<ListVoiceConnectorTerminationCredentialsRequest.Builder> listVoiceConnectorTerminationCredentialsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
ListVoiceConnectorTerminationCredentialsRequest.Builder avoiding the need to create one manually via
ListVoiceConnectorTerminationCredentialsRequest.builder()
listVoiceConnectorTerminationCredentialsRequest - A Consumer that will call methods on
ListVoiceConnectorTerminationCredentialsRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorsResponse listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
listVoiceConnectorsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorsResponse listVoiceConnectors(Consumer<ListVoiceConnectorsRequest.Builder> listVoiceConnectorsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ListVoiceConnectorsRequest.Builder avoiding the
need to create one manually via ListVoiceConnectorsRequest.builder()
listVoiceConnectorsRequest - A Consumer that will call methods on
ListVoiceConnectorsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorsIterable listVoiceConnectorsPaginator(ListVoiceConnectorsRequest listVoiceConnectorsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listVoiceConnectors(software.amazon.awssdk.services.chime.model.ListVoiceConnectorsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsIterable responses = client.listVoiceConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsIterable responses = client
.listVoiceConnectorsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListVoiceConnectorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsIterable responses = client.listVoiceConnectorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVoiceConnectors(software.amazon.awssdk.services.chime.model.ListVoiceConnectorsRequest)
operation.
listVoiceConnectorsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ListVoiceConnectorsIterable listVoiceConnectorsPaginator(Consumer<ListVoiceConnectorsRequest.Builder> listVoiceConnectorsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
listVoiceConnectors(software.amazon.awssdk.services.chime.model.ListVoiceConnectorsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsIterable responses = client.listVoiceConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsIterable responses = client
.listVoiceConnectorsPaginator(request);
for (software.amazon.awssdk.services.chime.model.ListVoiceConnectorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsIterable responses = client.listVoiceConnectorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVoiceConnectors(software.amazon.awssdk.services.chime.model.ListVoiceConnectorsRequest)
operation.
This is a convenience which creates an instance of the ListVoiceConnectorsRequest.Builder avoiding the
need to create one manually via ListVoiceConnectorsRequest.builder()
listVoiceConnectorsRequest - A Consumer that will call methods on
ListVoiceConnectorsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault LogoutUserResponse logoutUser(LogoutUserRequest logoutUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Logs out the specified user from all of the devices they are currently logged into.
logoutUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault LogoutUserResponse logoutUser(Consumer<LogoutUserRequest.Builder> logoutUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Logs out the specified user from all of the devices they are currently logged into.
This is a convenience which creates an instance of the LogoutUserRequest.Builder avoiding the need to
create one manually via LogoutUserRequest.builder()
logoutUserRequest - A Consumer that will call methods on
LogoutUserRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutAppInstanceRetentionSettingsResponse putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putAppInstanceRetentionSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutAppInstanceRetentionSettingsResponse putAppInstanceRetentionSettings(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the PutAppInstanceRetentionSettingsRequest.Builder
avoiding the need to create one manually via PutAppInstanceRetentionSettingsRequest.builder()
putAppInstanceRetentionSettingsRequest - A Consumer that will call methods on
PutAppInstanceRetentionSettingsRequest.Builder to
create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutAppInstanceStreamingConfigurationsResponse putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest putAppInstanceStreamingConfigurationsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putAppInstanceStreamingConfigurationsRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutAppInstanceStreamingConfigurationsResponse putAppInstanceStreamingConfigurations(Consumer<PutAppInstanceStreamingConfigurationsRequest.Builder> putAppInstanceStreamingConfigurationsRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
PutAppInstanceStreamingConfigurationsRequest.Builder avoiding the need to create one manually via
PutAppInstanceStreamingConfigurationsRequest.builder()
putAppInstanceStreamingConfigurationsRequest - A Consumer that will call methods on
PutAppInstanceStreamingConfigurationsRequest.Builder
to create a request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEventsConfigurationResponse putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, AwsServiceException, SdkClientException, ChimeException
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.
putEventsConfigurationRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEventsConfigurationResponse putEventsConfiguration(Consumer<PutEventsConfigurationRequest.Builder> putEventsConfigurationRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, ResourceLimitExceededException, NotFoundException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the PutEventsConfigurationRequest.Builder avoiding the
need to create one manually via PutEventsConfigurationRequest.builder()
putEventsConfigurationRequest - A Consumer that will call methods on
PutEventsConfigurationRequest.Builder to create a
request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRetentionSettingsResponse putRetentionSettings(PutRetentionSettingsRequest putRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putRetentionSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRetentionSettingsResponse putRetentionSettings(Consumer<PutRetentionSettingsRequest.Builder> putRetentionSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the PutRetentionSettingsRequest.Builder avoiding the
need to create one manually via PutRetentionSettingsRequest.builder()
putRetentionSettingsRequest - A Consumer that will call methods on
PutRetentionSettingsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutSipMediaApplicationLoggingConfigurationResponse putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest putSipMediaApplicationLoggingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putSipMediaApplicationLoggingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutSipMediaApplicationLoggingConfigurationResponse putSipMediaApplicationLoggingConfiguration(Consumer<PutSipMediaApplicationLoggingConfigurationRequest.Builder> putSipMediaApplicationLoggingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
PutSipMediaApplicationLoggingConfigurationRequest.Builder avoiding the need to create one manually via
PutSipMediaApplicationLoggingConfigurationRequest.builder()
putSipMediaApplicationLoggingConfigurationRequest - A Consumer that will call methods on
PutSipMediaApplicationLoggingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorEmergencyCallingConfigurationResponse putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest putVoiceConnectorEmergencyCallingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putVoiceConnectorEmergencyCallingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorEmergencyCallingConfigurationResponse putVoiceConnectorEmergencyCallingConfiguration(Consumer<PutVoiceConnectorEmergencyCallingConfigurationRequest.Builder> putVoiceConnectorEmergencyCallingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
PutVoiceConnectorEmergencyCallingConfigurationRequest.Builder avoiding the need to create one manually
via PutVoiceConnectorEmergencyCallingConfigurationRequest.builder()
putVoiceConnectorEmergencyCallingConfigurationRequest - A Consumer that will call methods on
PutVoiceConnectorEmergencyCallingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorLoggingConfigurationResponse putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest putVoiceConnectorLoggingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putVoiceConnectorLoggingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorLoggingConfigurationResponse putVoiceConnectorLoggingConfiguration(Consumer<PutVoiceConnectorLoggingConfigurationRequest.Builder> putVoiceConnectorLoggingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
PutVoiceConnectorLoggingConfigurationRequest.Builder avoiding the need to create one manually via
PutVoiceConnectorLoggingConfigurationRequest.builder()
putVoiceConnectorLoggingConfigurationRequest - A Consumer that will call methods on
PutVoiceConnectorLoggingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorOriginationResponse putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putVoiceConnectorOriginationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorOriginationResponse putVoiceConnectorOrigination(Consumer<PutVoiceConnectorOriginationRequest.Builder> putVoiceConnectorOriginationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the PutVoiceConnectorOriginationRequest.Builder
avoiding the need to create one manually via PutVoiceConnectorOriginationRequest.builder()
putVoiceConnectorOriginationRequest - A Consumer that will call methods on
PutVoiceConnectorOriginationRequest.Builder to create
a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorProxyResponse putVoiceConnectorProxy(PutVoiceConnectorProxyRequest putVoiceConnectorProxyRequest) throws UnauthorizedClientException, AccessDeniedException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putVoiceConnectorProxyRequest - UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorProxyResponse putVoiceConnectorProxy(Consumer<PutVoiceConnectorProxyRequest.Builder> putVoiceConnectorProxyRequest) throws UnauthorizedClientException, AccessDeniedException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the PutVoiceConnectorProxyRequest.Builder avoiding the
need to create one manually via PutVoiceConnectorProxyRequest.builder()
putVoiceConnectorProxyRequest - A Consumer that will call methods on
PutVoiceConnectorProxyRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorStreamingConfigurationResponse putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest putVoiceConnectorStreamingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putVoiceConnectorStreamingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorStreamingConfigurationResponse putVoiceConnectorStreamingConfiguration(Consumer<PutVoiceConnectorStreamingConfigurationRequest.Builder> putVoiceConnectorStreamingConfigurationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
PutVoiceConnectorStreamingConfigurationRequest.Builder avoiding the need to create one manually via
PutVoiceConnectorStreamingConfigurationRequest.builder()
putVoiceConnectorStreamingConfigurationRequest - A Consumer that will call methods on
PutVoiceConnectorStreamingConfigurationRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorTerminationResponse putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putVoiceConnectorTerminationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorTerminationResponse putVoiceConnectorTermination(Consumer<PutVoiceConnectorTerminationRequest.Builder> putVoiceConnectorTerminationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, AccessDeniedException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the PutVoiceConnectorTerminationRequest.Builder
avoiding the need to create one manually via PutVoiceConnectorTerminationRequest.builder()
putVoiceConnectorTerminationRequest - A Consumer that will call methods on
PutVoiceConnectorTerminationRequest.Builder to create
a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorTerminationCredentialsResponse putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
putVoiceConnectorTerminationCredentialsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default PutVoiceConnectorTerminationCredentialsResponse putVoiceConnectorTerminationCredentials(Consumer<PutVoiceConnectorTerminationCredentialsRequest.Builder> putVoiceConnectorTerminationCredentialsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the
PutVoiceConnectorTerminationCredentialsRequest.Builder avoiding the need to create one manually via
PutVoiceConnectorTerminationCredentialsRequest.builder()
putVoiceConnectorTerminationCredentialsRequest - A Consumer that will call methods on
PutVoiceConnectorTerminationCredentialsRequest.Builder
to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default RedactChannelMessageResponse redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
redactChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default RedactChannelMessageResponse redactChannelMessage(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest) throws BadRequestException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the RedactChannelMessageRequest.Builder avoiding the
need to create one manually via RedactChannelMessageRequest.builder()
redactChannelMessageRequest - A Consumer that will call methods on
RedactChannelMessageRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RedactConversationMessageResponse redactConversationMessage(RedactConversationMessageRequest redactConversationMessageRequest) throws NotFoundException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, BadRequestException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Redacts the specified message from the specified Amazon Chime conversation.
redactConversationMessageRequest - NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.BadRequestException - The input parameters don't match the service's restrictions.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RedactConversationMessageResponse redactConversationMessage(Consumer<RedactConversationMessageRequest.Builder> redactConversationMessageRequest) throws NotFoundException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, BadRequestException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Redacts the specified message from the specified Amazon Chime conversation.
This is a convenience which creates an instance of the RedactConversationMessageRequest.Builder avoiding
the need to create one manually via RedactConversationMessageRequest.builder()
redactConversationMessageRequest - A Consumer that will call methods on
RedactConversationMessageRequest.Builder to create a
request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.BadRequestException - The input parameters don't match the service's restrictions.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RedactRoomMessageResponse redactRoomMessage(RedactRoomMessageRequest redactRoomMessageRequest) throws NotFoundException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, BadRequestException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Redacts the specified message from the specified Amazon Chime channel.
redactRoomMessageRequest - NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.BadRequestException - The input parameters don't match the service's restrictions.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RedactRoomMessageResponse redactRoomMessage(Consumer<RedactRoomMessageRequest.Builder> redactRoomMessageRequest) throws NotFoundException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, BadRequestException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Redacts the specified message from the specified Amazon Chime channel.
This is a convenience which creates an instance of the RedactRoomMessageRequest.Builder avoiding the need
to create one manually via RedactRoomMessageRequest.builder()
redactRoomMessageRequest - A Consumer that will call methods on
RedactRoomMessageRequest.Builder to create a request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.BadRequestException - The input parameters don't match the service's restrictions.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegenerateSecurityTokenResponse regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Regenerates the security token for a bot.
regenerateSecurityTokenRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegenerateSecurityTokenResponse regenerateSecurityToken(Consumer<RegenerateSecurityTokenRequest.Builder> regenerateSecurityTokenRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Regenerates the security token for a bot.
This is a convenience which creates an instance of the RegenerateSecurityTokenRequest.Builder avoiding
the need to create one manually via RegenerateSecurityTokenRequest.builder()
regenerateSecurityTokenRequest - A Consumer that will call methods on
RegenerateSecurityTokenRequest.Builder to create a
request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetPersonalPinResponse resetPersonalPIN(ResetPersonalPinRequest resetPersonalPinRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
resetPersonalPinRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetPersonalPinResponse resetPersonalPIN(Consumer<ResetPersonalPinRequest.Builder> resetPersonalPinRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
This is a convenience which creates an instance of the ResetPersonalPinRequest.Builder avoiding the need
to create one manually via ResetPersonalPinRequest.builder()
resetPersonalPinRequest - A Consumer that will call methods on
ResetPersonalPinRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestorePhoneNumberResponse restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Moves a phone number from the Deletion queue back into the phone number Inventory.
restorePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestorePhoneNumberResponse restorePhoneNumber(Consumer<RestorePhoneNumberRequest.Builder> restorePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Moves a phone number from the Deletion queue back into the phone number Inventory.
This is a convenience which creates an instance of the RestorePhoneNumberRequest.Builder avoiding the
need to create one manually via RestorePhoneNumberRequest.builder()
restorePhoneNumberRequest - A Consumer that will call methods on
RestorePhoneNumberRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchAvailablePhoneNumbersResponse searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
searchAvailablePhoneNumbersRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchAvailablePhoneNumbersResponse searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the SearchAvailablePhoneNumbersRequest.Builder
avoiding the need to create one manually via SearchAvailablePhoneNumbersRequest.builder()
searchAvailablePhoneNumbersRequest - A Consumer that will call methods on
SearchAvailablePhoneNumbersRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchAvailablePhoneNumbersIterable searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client
.searchAvailablePhoneNumbersPaginator(request);
for (software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)
operation.
searchAvailablePhoneNumbersRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchAvailablePhoneNumbersIterable searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) throws BadRequestException, ForbiddenException, AccessDeniedException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a variant of
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client
.searchAvailablePhoneNumbersPaginator(request);
for (software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersIterable responses = client.searchAvailablePhoneNumbersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)
operation.
This is a convenience which creates an instance of the SearchAvailablePhoneNumbersRequest.Builder
avoiding the need to create one manually via SearchAvailablePhoneNumbersRequest.builder()
searchAvailablePhoneNumbersRequest - A Consumer that will call methods on
SearchAvailablePhoneNumbersRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default SendChannelMessageResponse sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
sendChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default SendChannelMessageResponse sendChannelMessage(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the SendChannelMessageRequest.Builder avoiding the
need to create one manually via SendChannelMessageRequest.builder()
sendChannelMessageRequest - A Consumer that will call methods on
SendChannelMessageRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default StartMeetingTranscriptionResponse startMeetingTranscription(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest) throws NotFoundException, ForbiddenException, BadRequestException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, UnprocessableEntityException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
startMeetingTranscriptionRequest - NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default StartMeetingTranscriptionResponse startMeetingTranscription(Consumer<StartMeetingTranscriptionRequest.Builder> startMeetingTranscriptionRequest) throws NotFoundException, ForbiddenException, BadRequestException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, UnprocessableEntityException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the StartMeetingTranscriptionRequest.Builder avoiding
the need to create one manually via StartMeetingTranscriptionRequest.builder()
startMeetingTranscriptionRequest - A Consumer that will call methods on
StartMeetingTranscriptionRequest.Builder to create a
request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default StopMeetingTranscriptionResponse stopMeetingTranscription(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest) throws ForbiddenException, NotFoundException, BadRequestException, ThrottledClientException, UnauthorizedClientException, UnprocessableEntityException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
stopMeetingTranscriptionRequest - ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default StopMeetingTranscriptionResponse stopMeetingTranscription(Consumer<StopMeetingTranscriptionRequest.Builder> stopMeetingTranscriptionRequest) throws ForbiddenException, NotFoundException, BadRequestException, ThrottledClientException, UnauthorizedClientException, UnprocessableEntityException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the StopMeetingTranscriptionRequest.Builder avoiding
the need to create one manually via StopMeetingTranscriptionRequest.builder()
stopMeetingTranscriptionRequest - A Consumer that will call methods on
StopMeetingTranscriptionRequest.Builder to create a
request.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default TagAttendeeResponse tagAttendee(TagAttendeeRequest tagAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
tagAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default TagAttendeeResponse tagAttendee(Consumer<TagAttendeeRequest.Builder> tagAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the TagAttendeeRequest.Builder avoiding the need to
create one manually via TagAttendeeRequest.builder()
tagAttendeeRequest - A Consumer that will call methods on
TagAttendeeRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default TagMeetingResponse tagMeeting(TagMeetingRequest tagMeetingRequest) throws BadRequestException, ForbiddenException, NotFoundException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
tagMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default TagMeetingResponse tagMeeting(Consumer<TagMeetingRequest.Builder> tagMeetingRequest) throws BadRequestException, ForbiddenException, NotFoundException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the TagMeetingRequest.Builder avoiding the need to
create one manually via TagMeetingRequest.builder()
tagMeetingRequest - A Consumer that will call methods on
TagMeetingRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
tagResourceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UntagAttendeeResponse untagAttendee(UntagAttendeeRequest untagAttendeeRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
untagAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UntagAttendeeResponse untagAttendee(Consumer<UntagAttendeeRequest.Builder> untagAttendeeRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UntagAttendeeRequest.Builder avoiding the need to
create one manually via UntagAttendeeRequest.builder()
untagAttendeeRequest - A Consumer that will call methods on
UntagAttendeeRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UntagMeetingResponse untagMeeting(UntagMeetingRequest untagMeetingRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
untagMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UntagMeetingResponse untagMeeting(Consumer<UntagMeetingRequest.Builder> untagMeetingRequest) throws BadRequestException, ForbiddenException, ThrottledClientException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UntagMeetingRequest.Builder avoiding the need to
create one manually via UntagMeetingRequest.builder()
untagMeetingRequest - A Consumer that will call methods on
UntagMeetingRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
untagResourceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAccountResponse updateAccount(UpdateAccountRequest updateAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
updateAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAccountResponse updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
This is a convenience which creates an instance of the UpdateAccountRequest.Builder avoiding the need to
create one manually via UpdateAccountRequest.builder()
updateAccountRequest - A Consumer that will call methods on
UpdateAccountRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAccountSettingsResponse updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateAccountSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAccountSettingsResponse updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateAccountSettingsRequest.Builder avoiding the
need to create one manually via UpdateAccountSettingsRequest.builder()
updateAccountSettingsRequest - A Consumer that will call methods on
UpdateAccountSettingsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateAppInstanceResponse updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateAppInstanceRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateAppInstanceResponse updateAppInstance(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateAppInstanceRequest.Builder avoiding the need
to create one manually via UpdateAppInstanceRequest.builder()
updateAppInstanceRequest - A Consumer that will call methods on
UpdateAppInstanceRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateAppInstanceUserResponse updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateAppInstanceUserResponse updateAppInstanceUser(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest) throws BadRequestException, ConflictException, ForbiddenException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateAppInstanceUserRequest.Builder avoiding the
need to create one manually via UpdateAppInstanceUserRequest.builder()
updateAppInstanceUserRequest - A Consumer that will call methods on
UpdateAppInstanceUserRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBotResponse updateBot(UpdateBotRequest updateBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
updateBotRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBotResponse updateBot(Consumer<UpdateBotRequest.Builder> updateBotRequest) throws ServiceUnavailableException, ServiceFailureException, ForbiddenException, BadRequestException, UnauthorizedClientException, NotFoundException, ThrottledClientException, AwsServiceException, SdkClientException, ChimeException
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
This is a convenience which creates an instance of the UpdateBotRequest.Builder avoiding the need to
create one manually via UpdateBotRequest.builder()
updateBotRequest - A Consumer that will call methods on
UpdateBotRequest.Builder to create a request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateChannelResponse updateChannel(UpdateChannelRequest updateChannelRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateChannelResponse updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateChannelRequest.Builder avoiding the need to
create one manually via UpdateChannelRequest.builder()
updateChannelRequest - A Consumer that will call methods on
UpdateChannelRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateChannelMessageResponse updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateChannelMessageResponse updateChannelMessage(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateChannelMessageRequest.Builder avoiding the
need to create one manually via UpdateChannelMessageRequest.builder()
updateChannelMessageRequest - A Consumer that will call methods on
UpdateChannelMessageRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateChannelReadMarkerResponse updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateChannelReadMarkerRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateChannelReadMarkerResponse updateChannelReadMarker(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest) throws BadRequestException, ForbiddenException, ConflictException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateChannelReadMarkerRequest.Builder avoiding
the need to create one manually via UpdateChannelReadMarkerRequest.builder()
updateChannelReadMarkerRequest - A Consumer that will call methods on
UpdateChannelReadMarkerRequest.Builder to create a
request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGlobalSettingsResponse updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
updateGlobalSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGlobalSettingsResponse updateGlobalSettings(Consumer<UpdateGlobalSettingsRequest.Builder> updateGlobalSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
This is a convenience which creates an instance of the UpdateGlobalSettingsRequest.Builder avoiding the
need to create one manually via UpdateGlobalSettingsRequest.builder()
updateGlobalSettingsRequest - A Consumer that will call methods on
UpdateGlobalSettingsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePhoneNumberResponse updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updatePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePhoneNumberResponse updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ConflictException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdatePhoneNumberRequest.Builder avoiding the need
to create one manually via UpdatePhoneNumberRequest.builder()
updatePhoneNumberRequest - A Consumer that will call methods on
UpdatePhoneNumberRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePhoneNumberSettingsResponse updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updatePhoneNumberSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePhoneNumberSettingsResponse updatePhoneNumberSettings(Consumer<UpdatePhoneNumberSettingsRequest.Builder> updatePhoneNumberSettingsRequest) throws UnauthorizedClientException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdatePhoneNumberSettingsRequest.Builder avoiding
the need to create one manually via UpdatePhoneNumberSettingsRequest.builder()
updatePhoneNumberSettingsRequest - A Consumer that will call methods on
UpdatePhoneNumberSettingsRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateProxySessionResponse updateProxySession(UpdateProxySessionRequest updateProxySessionRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateProxySessionRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateProxySessionResponse updateProxySession(Consumer<UpdateProxySessionRequest.Builder> updateProxySessionRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateProxySessionRequest.Builder avoiding the
need to create one manually via UpdateProxySessionRequest.builder()
updateProxySessionRequest - A Consumer that will call methods on
UpdateProxySessionRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRoomResponse updateRoom(UpdateRoomRequest updateRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
updateRoomRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRoomResponse updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedClientException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
This is a convenience which creates an instance of the UpdateRoomRequest.Builder avoiding the need to
create one manually via UpdateRoomRequest.builder()
updateRoomRequest - A Consumer that will call methods on
UpdateRoomRequest.Builder to create a request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRoomMembershipResponse updateRoomMembership(UpdateRoomMembershipRequest updateRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateRoomMembershipRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRoomMembershipResponse updateRoomMembership(Consumer<UpdateRoomMembershipRequest.Builder> updateRoomMembershipRequest) throws UnauthorizedClientException, NotFoundException, BadRequestException, ForbiddenException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateRoomMembershipRequest.Builder avoiding the
need to create one manually via UpdateRoomMembershipRequest.builder()
updateRoomMembershipRequest - A Consumer that will call methods on
UpdateRoomMembershipRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateSipMediaApplicationResponse updateSipMediaApplication(UpdateSipMediaApplicationRequest updateSipMediaApplicationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateSipMediaApplicationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateSipMediaApplicationResponse updateSipMediaApplication(Consumer<UpdateSipMediaApplicationRequest.Builder> updateSipMediaApplicationRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateSipMediaApplicationRequest.Builder avoiding
the need to create one manually via UpdateSipMediaApplicationRequest.builder()
updateSipMediaApplicationRequest - A Consumer that will call methods on
UpdateSipMediaApplicationRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateSipMediaApplicationCallResponse updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest updateSipMediaApplicationCallRequest) throws BadRequestException, NotFoundException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateSipMediaApplicationCallRequest - BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateSipMediaApplicationCallResponse updateSipMediaApplicationCall(Consumer<UpdateSipMediaApplicationCallRequest.Builder> updateSipMediaApplicationCallRequest) throws BadRequestException, NotFoundException, ForbiddenException, ResourceLimitExceededException, ThrottledClientException, UnauthorizedClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateSipMediaApplicationCallRequest.Builder
avoiding the need to create one manually via UpdateSipMediaApplicationCallRequest.builder()
updateSipMediaApplicationCallRequest - A Consumer that will call methods on
UpdateSipMediaApplicationCallRequest.Builder to create
a request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateSipRuleResponse updateSipRule(UpdateSipRuleRequest updateSipRuleRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateSipRuleRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateSipRuleResponse updateSipRule(Consumer<UpdateSipRuleRequest.Builder> updateSipRuleRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ResourceLimitExceededException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateSipRuleRequest.Builder avoiding the need to
create one manually via UpdateSipRuleRequest.builder()
updateSipRuleRequest - A Consumer that will call methods on
UpdateSipRuleRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for
this action.
updateUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for
this action.
This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to
create one manually via UpdateUserRequest.builder()
updateUserRequest - A Consumer that will call methods on
UpdateUserRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserSettingsResponse updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates the settings for the specified user, such as phone number settings.
updateUserSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUserSettingsResponse updateUserSettings(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
Updates the settings for the specified user, such as phone number settings.
This is a convenience which creates an instance of the UpdateUserSettingsRequest.Builder avoiding the
need to create one manually via UpdateUserSettingsRequest.builder()
updateUserSettingsRequest - A Consumer that will call methods on
UpdateUserSettingsRequest.Builder to create a request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateVoiceConnectorResponse updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateVoiceConnectorResponse updateVoiceConnector(Consumer<UpdateVoiceConnectorRequest.Builder> updateVoiceConnectorRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateVoiceConnectorRequest.Builder avoiding the
need to create one manually via UpdateVoiceConnectorRequest.builder()
updateVoiceConnectorRequest - A Consumer that will call methods on
UpdateVoiceConnectorRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateVoiceConnectorGroupResponse updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest updateVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
updateVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default UpdateVoiceConnectorGroupResponse updateVoiceConnectorGroup(Consumer<UpdateVoiceConnectorGroupRequest.Builder> updateVoiceConnectorGroupRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ConflictException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the UpdateVoiceConnectorGroupRequest.Builder avoiding
the need to create one manually via UpdateVoiceConnectorGroupRequest.builder()
updateVoiceConnectorGroupRequest - A Consumer that will call methods on
UpdateVoiceConnectorGroupRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ValidateE911AddressResponse validateE911Address(ValidateE911AddressRequest validateE911AddressRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
validateE911AddressRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException@Deprecated default ValidateE911AddressResponse validateE911Address(Consumer<ValidateE911AddressRequest.Builder> validateE911AddressRequest) throws UnauthorizedClientException, NotFoundException, ForbiddenException, BadRequestException, ThrottledClientException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeException
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.
This is a convenience which creates an instance of the ValidateE911AddressRequest.Builder avoiding the
need to create one manually via ValidateE911AddressRequest.builder()
validateE911AddressRequest - A Consumer that will call methods on
ValidateE911AddressRequest.Builder to create a
request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ChimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ChimeClient create()
ChimeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ChimeClientBuilder builder()
ChimeClient.static ServiceMetadata serviceMetadata()
default ChimeServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.