Interface ChimeAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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.
- Using an AWS SDK
-
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.
- Using the AWS CLI
-
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.
- Using REST APIs
-
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 endpointhttps://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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociatePhoneNumbersWithVoiceConnector
(Consumer<AssociatePhoneNumbersWithVoiceConnectorRequest.Builder> associatePhoneNumbersWithVoiceConnectorRequest) Deprecated.Replaced by AssociatePhoneNumbersWithVoiceConnector in the Amazon Chime SDK Voice NamespaceassociatePhoneNumbersWithVoiceConnector
(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest) Deprecated.Replaced by AssociatePhoneNumbersWithVoiceConnector in the Amazon Chime SDK Voice NamespaceassociatePhoneNumbersWithVoiceConnectorGroup
(Consumer<AssociatePhoneNumbersWithVoiceConnectorGroupRequest.Builder> associatePhoneNumbersWithVoiceConnectorGroupRequest) Deprecated.Replaced by AssociatePhoneNumbersWithVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceassociatePhoneNumbersWithVoiceConnectorGroup
(AssociatePhoneNumbersWithVoiceConnectorGroupRequest associatePhoneNumbersWithVoiceConnectorGroupRequest) Deprecated.Replaced by AssociatePhoneNumbersWithVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceassociatePhoneNumberWithUser
(Consumer<AssociatePhoneNumberWithUserRequest.Builder> associatePhoneNumberWithUserRequest) Associates a phone number with the specified Amazon Chime user.associatePhoneNumberWithUser
(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest) Associates a phone number with the specified Amazon Chime user.associateSigninDelegateGroupsWithAccount
(Consumer<AssociateSigninDelegateGroupsWithAccountRequest.Builder> associateSigninDelegateGroupsWithAccountRequest) Associates the specified sign-in delegate groups with the specified Amazon Chime account.associateSigninDelegateGroupsWithAccount
(AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest) Associates the specified sign-in delegate groups with the specified Amazon Chime account.batchCreateAttendee
(Consumer<BatchCreateAttendeeRequest.Builder> batchCreateAttendeeRequest) Deprecated.Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings NamespacebatchCreateAttendee
(BatchCreateAttendeeRequest batchCreateAttendeeRequest) Deprecated.Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings NamespacebatchCreateChannelMembership
(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest) Deprecated.Replaced by BatchCreateChannelMembership in the Amazon Chime SDK Messaging NamespacebatchCreateChannelMembership
(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest) Deprecated.Replaced by BatchCreateChannelMembership in the Amazon Chime SDK Messaging NamespacebatchCreateRoomMembership
(Consumer<BatchCreateRoomMembershipRequest.Builder> batchCreateRoomMembershipRequest) Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.batchCreateRoomMembership
(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest) Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.batchDeletePhoneNumber
(Consumer<BatchDeletePhoneNumberRequest.Builder> batchDeletePhoneNumberRequest) Moves phone numbers into the Deletion queue.batchDeletePhoneNumber
(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest) Moves phone numbers into the Deletion queue.batchSuspendUser
(Consumer<BatchSuspendUserRequest.Builder> batchSuspendUserRequest) Suspends up to 50 users from aTeam
orEnterpriseLWA
Amazon Chime account.batchSuspendUser
(BatchSuspendUserRequest batchSuspendUserRequest) Suspends up to 50 users from aTeam
orEnterpriseLWA
Amazon Chime account.batchUnsuspendUser
(Consumer<BatchUnsuspendUserRequest.Builder> batchUnsuspendUserRequest) Removes the suspension from up to 50 previously suspended users for the specified Amazon ChimeEnterpriseLWA
account.batchUnsuspendUser
(BatchUnsuspendUserRequest batchUnsuspendUserRequest) Removes the suspension from up to 50 previously suspended users for the specified Amazon ChimeEnterpriseLWA
account.batchUpdatePhoneNumber
(Consumer<BatchUpdatePhoneNumberRequest.Builder> batchUpdatePhoneNumberRequest) Updates phone number product types or calling names.batchUpdatePhoneNumber
(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest) Updates phone number product types or calling names.default CompletableFuture
<BatchUpdateUserResponse> batchUpdateUser
(Consumer<BatchUpdateUserRequest.Builder> batchUpdateUserRequest) Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.default CompletableFuture
<BatchUpdateUserResponse> batchUpdateUser
(BatchUpdateUserRequest batchUpdateUserRequest) Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.static ChimeAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aChimeAsyncClient
.static ChimeAsyncClient
create()
Create aChimeAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAccountResponse> createAccount
(Consumer<CreateAccountRequest.Builder> createAccountRequest) Creates an Amazon Chime account under the administrator's AWS account.default CompletableFuture
<CreateAccountResponse> createAccount
(CreateAccountRequest createAccountRequest) Creates an Amazon Chime account under the administrator's AWS account.createAppInstance
(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest) Deprecated.Replaced by CreateAppInstance in the Amazon Chime SDK Identity NamespacecreateAppInstance
(CreateAppInstanceRequest createAppInstanceRequest) Deprecated.Replaced by CreateAppInstance in the Amazon Chime SDK Identity NamespacecreateAppInstanceAdmin
(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest) Deprecated.Replaced by CreateAppInstanceAdmin in the Amazon Chime SDK Identity NamespacecreateAppInstanceAdmin
(CreateAppInstanceAdminRequest createAppInstanceAdminRequest) Deprecated.Replaced by CreateAppInstanceAdmin in the Amazon Chime SDK Identity NamespacecreateAppInstanceUser
(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest) Deprecated.Replaced by CreateAppInstanceUser in the Amazon Chime SDK Identity NamespacecreateAppInstanceUser
(CreateAppInstanceUserRequest createAppInstanceUserRequest) Deprecated.Replaced by CreateAppInstanceUser in the Amazon Chime SDK Identity Namespacedefault CompletableFuture
<CreateAttendeeResponse> createAttendee
(Consumer<CreateAttendeeRequest.Builder> createAttendeeRequest) Deprecated.Replaced by CreateAttendee in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<CreateAttendeeResponse> createAttendee
(CreateAttendeeRequest createAttendeeRequest) Deprecated.Replaced by CreateAttendee in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<CreateBotResponse> createBot
(Consumer<CreateBotRequest.Builder> createBotRequest) Creates a bot for an Amazon Chime Enterprise account.default CompletableFuture
<CreateBotResponse> createBot
(CreateBotRequest createBotRequest) Creates a bot for an Amazon Chime Enterprise account.default CompletableFuture
<CreateChannelResponse> createChannel
(Consumer<CreateChannelRequest.Builder> createChannelRequest) Deprecated.Replaced by CreateChannel in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<CreateChannelResponse> createChannel
(CreateChannelRequest createChannelRequest) Deprecated.Replaced by CreateChannel in the Amazon Chime SDK Messaging NamespacecreateChannelBan
(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest) Deprecated.Replaced by CreateChannelBan in the Amazon Chime SDK Messaging NamespacecreateChannelBan
(CreateChannelBanRequest createChannelBanRequest) Deprecated.Replaced by CreateChannelBan in the Amazon Chime SDK Messaging NamespacecreateChannelMembership
(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest) Deprecated.Replaced by CreateChannelMembership in the Amazon Chime SDK Messaging NamespacecreateChannelMembership
(CreateChannelMembershipRequest createChannelMembershipRequest) Deprecated.Replaced by CreateChannelMembership in the Amazon Chime SDK Messaging NamespacecreateChannelModerator
(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest) Deprecated.Replaced by CreateChannelModerator in the Amazon Chime SDK Messaging NamespacecreateChannelModerator
(CreateChannelModeratorRequest createChannelModeratorRequest) Deprecated.Replaced by CreateChannelModerator in the Amazon Chime SDK Messaging NamespacecreateMediaCapturePipeline
(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest) Deprecated.Replaced by CreateMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespacecreateMediaCapturePipeline
(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest) Deprecated.Replaced by CreateMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespacedefault CompletableFuture
<CreateMeetingResponse> createMeeting
(Consumer<CreateMeetingRequest.Builder> createMeetingRequest) Deprecated.Replaced by CreateMeeting in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<CreateMeetingResponse> createMeeting
(CreateMeetingRequest createMeetingRequest) Deprecated.Replaced by CreateMeeting in the Amazon Chime SDK Meetings NamespacecreateMeetingDialOut
(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.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.createMeetingWithAttendees
(Consumer<CreateMeetingWithAttendeesRequest.Builder> createMeetingWithAttendeesRequest) Deprecated.Replaced by CreateMeetingWithAttendees in the Amazon Chime SDK Meetings NamespacecreateMeetingWithAttendees
(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest) Deprecated.Replaced by CreateMeetingWithAttendees in the Amazon Chime SDK Meetings NamespacecreatePhoneNumberOrder
(Consumer<CreatePhoneNumberOrderRequest.Builder> createPhoneNumberOrderRequest) Creates an order for phone numbers to be provisioned.createPhoneNumberOrder
(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest) Creates an order for phone numbers to be provisioned.createProxySession
(Consumer<CreateProxySessionRequest.Builder> createProxySessionRequest) Deprecated.Replaced by CreateProxySession in the Amazon Chime SDK Voice NamespacecreateProxySession
(CreateProxySessionRequest createProxySessionRequest) Deprecated.Replaced by CreateProxySession in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<CreateRoomResponse> createRoom
(Consumer<CreateRoomRequest.Builder> createRoomRequest) Creates a chat room for the specified Amazon Chime Enterprise account.default CompletableFuture
<CreateRoomResponse> createRoom
(CreateRoomRequest createRoomRequest) Creates a chat room for the specified Amazon Chime Enterprise account.createRoomMembership
(Consumer<CreateRoomMembershipRequest.Builder> createRoomMembershipRequest) Adds a member to a chat room in an Amazon Chime Enterprise account.createRoomMembership
(CreateRoomMembershipRequest createRoomMembershipRequest) Adds a member to a chat room in an Amazon Chime Enterprise account.createSipMediaApplication
(Consumer<CreateSipMediaApplicationRequest.Builder> createSipMediaApplicationRequest) Deprecated.Replaced by CreateSipMediaApplication in the Amazon Chime SDK Voice NamespacecreateSipMediaApplication
(CreateSipMediaApplicationRequest createSipMediaApplicationRequest) Deprecated.Replaced by CreateSipMediaApplication in the Amazon Chime SDK Voice NamespacecreateSipMediaApplicationCall
(Consumer<CreateSipMediaApplicationCallRequest.Builder> createSipMediaApplicationCallRequest) Deprecated.Replaced by CreateSipMediaApplicationCall in the Amazon Chime SDK Voice NamespacecreateSipMediaApplicationCall
(CreateSipMediaApplicationCallRequest createSipMediaApplicationCallRequest) Deprecated.Replaced by CreateSipMediaApplicationCall in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<CreateSipRuleResponse> createSipRule
(Consumer<CreateSipRuleRequest.Builder> createSipRuleRequest) Deprecated.Replaced by CreateSipRule in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<CreateSipRuleResponse> createSipRule
(CreateSipRuleRequest createSipRuleRequest) Deprecated.Replaced by CreateSipRule in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<CreateUserResponse> createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a user under the specified Amazon Chime account.default CompletableFuture
<CreateUserResponse> createUser
(CreateUserRequest createUserRequest) Creates a user under the specified Amazon Chime account.createVoiceConnector
(Consumer<CreateVoiceConnectorRequest.Builder> createVoiceConnectorRequest) Deprecated.Replaced by CreateVoiceConnector in the Amazon Chime SDK Voice NamespacecreateVoiceConnector
(CreateVoiceConnectorRequest createVoiceConnectorRequest) Deprecated.Replaced by CreateVoiceConnector in the Amazon Chime SDK Voice NamespacecreateVoiceConnectorGroup
(Consumer<CreateVoiceConnectorGroupRequest.Builder> createVoiceConnectorGroupRequest) Deprecated.Replaced by CreateVoiceConnectorGroup in the Amazon Chime SDK Voice NamespacecreateVoiceConnectorGroup
(CreateVoiceConnectorGroupRequest createVoiceConnectorGroupRequest) Deprecated.Replaced by CreateVoiceConnectorGroup in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<DeleteAccountResponse> deleteAccount
(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest) Deletes the specified Amazon Chime account.default CompletableFuture
<DeleteAccountResponse> deleteAccount
(DeleteAccountRequest deleteAccountRequest) Deletes the specified Amazon Chime account.deleteAppInstance
(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest) Deprecated.Replaced by DeleteAppInstance in the Amazon Chime SDK Identity NamespacedeleteAppInstance
(DeleteAppInstanceRequest deleteAppInstanceRequest) Deprecated.Replaced by DeleteAppInstance in the Amazon Chime SDK Identity NamespacedeleteAppInstanceAdmin
(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest) Deprecated.Replaced by DeleteAppInstanceAdmin in the Amazon Chime SDK Identity NamespacedeleteAppInstanceAdmin
(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest) Deprecated.Replaced by DeleteAppInstanceAdmin in the Amazon Chime SDK Identity NamespacedeleteAppInstanceStreamingConfigurations
(Consumer<DeleteAppInstanceStreamingConfigurationsRequest.Builder> deleteAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by DeleteAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespacedeleteAppInstanceStreamingConfigurations
(DeleteAppInstanceStreamingConfigurationsRequest deleteAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by DeleteAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespacedeleteAppInstanceUser
(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest) Deprecated.Replaced by DeleteAppInstanceUser in the Amazon Chime SDK Identity NamespacedeleteAppInstanceUser
(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) Deprecated.Replaced by DeleteAppInstanceUser in the Amazon Chime SDK Identity Namespacedefault CompletableFuture
<DeleteAttendeeResponse> deleteAttendee
(Consumer<DeleteAttendeeRequest.Builder> deleteAttendeeRequest) Deprecated.Replaced by DeleteAttendee in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<DeleteAttendeeResponse> deleteAttendee
(DeleteAttendeeRequest deleteAttendeeRequest) Deprecated.Replaced by DeleteAttendee in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<DeleteChannelResponse> deleteChannel
(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Deprecated.Replaced by DeleteChannel in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<DeleteChannelResponse> deleteChannel
(DeleteChannelRequest deleteChannelRequest) Deprecated.Replaced by DeleteChannel in the Amazon Chime SDK Messaging NamespacedeleteChannelBan
(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest) Deprecated.Replaced by DeleteChannelBan in the Amazon Chime SDK Messaging NamespacedeleteChannelBan
(DeleteChannelBanRequest deleteChannelBanRequest) Deprecated.Replaced by DeleteChannelBan in the Amazon Chime SDK Messaging NamespacedeleteChannelMembership
(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest) Deprecated.Replaced by DeleteChannelMembership in the Amazon Chime SDK Messaging NamespacedeleteChannelMembership
(DeleteChannelMembershipRequest deleteChannelMembershipRequest) Deprecated.Replaced by DeleteChannelMembership in the Amazon Chime SDK Messaging NamespacedeleteChannelMessage
(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest) Deprecated.Replaced by DeleteChannelMessage in the Amazon Chime SDK Messaging NamespacedeleteChannelMessage
(DeleteChannelMessageRequest deleteChannelMessageRequest) Deprecated.Replaced by DeleteChannelMessage in the Amazon Chime SDK Messaging NamespacedeleteChannelModerator
(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest) Deprecated.Replaced by DeleteChannelModerator in the Amazon Chime SDK Messaging NamespacedeleteChannelModerator
(DeleteChannelModeratorRequest deleteChannelModeratorRequest) Deprecated.Replaced by DeleteChannelModerator in the Amazon Chime SDK Messaging NamespacedeleteEventsConfiguration
(Consumer<DeleteEventsConfigurationRequest.Builder> deleteEventsConfigurationRequest) Deletes the events configuration that allows a bot to receive outgoing events.deleteEventsConfiguration
(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest) Deletes the events configuration that allows a bot to receive outgoing events.deleteMediaCapturePipeline
(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest) Deprecated.Replaced by DeleteMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespacedeleteMediaCapturePipeline
(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest) Deprecated.Replaced by DeleteMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespacedefault CompletableFuture
<DeleteMeetingResponse> deleteMeeting
(Consumer<DeleteMeetingRequest.Builder> deleteMeetingRequest) Deprecated.Replaced by DeleteMeeting in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<DeleteMeetingResponse> deleteMeeting
(DeleteMeetingRequest deleteMeetingRequest) Deprecated.Replaced by DeleteMeeting in the Amazon Chime SDK Meetings NamespacedeletePhoneNumber
(Consumer<DeletePhoneNumberRequest.Builder> deletePhoneNumberRequest) Moves the specified phone number into the Deletion queue.deletePhoneNumber
(DeletePhoneNumberRequest deletePhoneNumberRequest) Moves the specified phone number into the Deletion queue.deleteProxySession
(Consumer<DeleteProxySessionRequest.Builder> deleteProxySessionRequest) Deprecated.Replaced by DeleteProxySession in the Amazon Chime SDK Voice NamespacedeleteProxySession
(DeleteProxySessionRequest deleteProxySessionRequest) Deprecated.Replaced by DeleteProxySession in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<DeleteRoomResponse> deleteRoom
(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) Deletes a chat room in an Amazon Chime Enterprise account.default CompletableFuture
<DeleteRoomResponse> deleteRoom
(DeleteRoomRequest deleteRoomRequest) Deletes a chat room in an Amazon Chime Enterprise account.deleteRoomMembership
(Consumer<DeleteRoomMembershipRequest.Builder> deleteRoomMembershipRequest) Removes a member from a chat room in an Amazon Chime Enterprise account.deleteRoomMembership
(DeleteRoomMembershipRequest deleteRoomMembershipRequest) Removes a member from a chat room in an Amazon Chime Enterprise account.deleteSipMediaApplication
(Consumer<DeleteSipMediaApplicationRequest.Builder> deleteSipMediaApplicationRequest) Deprecated.Replaced by DeleteSipMediaApplication in the Amazon Chime SDK Voice NamespacedeleteSipMediaApplication
(DeleteSipMediaApplicationRequest deleteSipMediaApplicationRequest) Deprecated.Replaced by DeleteSipMediaApplication in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<DeleteSipRuleResponse> deleteSipRule
(Consumer<DeleteSipRuleRequest.Builder> deleteSipRuleRequest) Deprecated.Replaced by DeleteSipRule in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<DeleteSipRuleResponse> deleteSipRule
(DeleteSipRuleRequest deleteSipRuleRequest) Deprecated.Replaced by DeleteSipRule in the Amazon Chime SDK Voice NamespacedeleteVoiceConnector
(Consumer<DeleteVoiceConnectorRequest.Builder> deleteVoiceConnectorRequest) Deprecated.Replaced by DeleteVoiceConnector in the Amazon Chime SDK Voice NamespacedeleteVoiceConnector
(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest) Deprecated.Replaced by DeleteVoiceConnector in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorEmergencyCallingConfiguration
(Consumer<DeleteVoiceConnectorEmergencyCallingConfigurationRequest.Builder> deleteVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by DeleteVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorEmergencyCallingConfiguration
(DeleteVoiceConnectorEmergencyCallingConfigurationRequest deleteVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by DeleteVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorGroup
(Consumer<DeleteVoiceConnectorGroupRequest.Builder> deleteVoiceConnectorGroupRequest) Deprecated.Replaced by DeleteVoiceConnectorGroup in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorGroup
(DeleteVoiceConnectorGroupRequest deleteVoiceConnectorGroupRequest) Deprecated.Replaced by DeleteVoiceConnectorGroup in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorOrigination
(Consumer<DeleteVoiceConnectorOriginationRequest.Builder> deleteVoiceConnectorOriginationRequest) Deprecated.Replaced by DeleteVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorOrigination
(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest) Deprecated.Replaced by DeleteVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorProxy
(Consumer<DeleteVoiceConnectorProxyRequest.Builder> deleteVoiceConnectorProxyRequest) Deprecated.Replaced by DeleteVoiceConnectorProxy in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorProxy
(DeleteVoiceConnectorProxyRequest deleteVoiceConnectorProxyRequest) Deprecated.Replaced by DeleteVoiceConnectorProxy in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorStreamingConfiguration
(Consumer<DeleteVoiceConnectorStreamingConfigurationRequest.Builder> deleteVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by DeleteVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorStreamingConfiguration
(DeleteVoiceConnectorStreamingConfigurationRequest deleteVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by DeleteVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorTermination
(Consumer<DeleteVoiceConnectorTerminationRequest.Builder> deleteVoiceConnectorTerminationRequest) Deprecated.Replaced by DeleteVoiceConnectorTermination in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorTermination
(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest) Deprecated.Replaced by DeleteVoiceConnectorTermination in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorTerminationCredentials
(Consumer<DeleteVoiceConnectorTerminationCredentialsRequest.Builder> deleteVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by DeleteVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespacedeleteVoiceConnectorTerminationCredentials
(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by DeleteVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespacedescribeAppInstance
(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest) Deprecated.Replaced by DescribeAppInstance in the Amazon Chime SDK Identity NamespacedescribeAppInstance
(DescribeAppInstanceRequest describeAppInstanceRequest) Deprecated.Replaced by DescribeAppInstance in the Amazon Chime SDK Identity NamespacedescribeAppInstanceAdmin
(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest) Deprecated.Replaced by DescribeAppInstanceAdmin in the Amazon Chime SDK Identity NamespacedescribeAppInstanceAdmin
(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) Deprecated.Replaced by DescribeAppInstanceAdmin in the Amazon Chime SDK Identity NamespacedescribeAppInstanceUser
(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest) Deprecated.Replaced by DescribeAppInstanceUser in the Amazon Chime SDK Identity NamespacedescribeAppInstanceUser
(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) Deprecated.Replaced by DescribeAppInstanceUser in the Amazon Chime SDK Identity Namespacedefault CompletableFuture
<DescribeChannelResponse> describeChannel
(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) Deprecated.Replaced by DescribeChannel in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<DescribeChannelResponse> describeChannel
(DescribeChannelRequest describeChannelRequest) Deprecated.Replaced by DescribeChannel in the Amazon Chime SDK Messaging NamespacedescribeChannelBan
(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest) Deprecated.Replaced by DescribeChannelBan in the Amazon Chime SDK Messaging NamespacedescribeChannelBan
(DescribeChannelBanRequest describeChannelBanRequest) Deprecated.Replaced by DescribeChannelBan in the Amazon Chime SDK Messaging NamespacedescribeChannelMembership
(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest) Deprecated.Replaced by DescribeChannelMembership in the Amazon Chime SDK Messaging NamespacedescribeChannelMembership
(DescribeChannelMembershipRequest describeChannelMembershipRequest) Deprecated.Replaced by DescribeChannelMembership in the Amazon Chime SDK Messaging NamespacedescribeChannelMembershipForAppInstanceUser
(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest) Deprecated.Replaced by DescribeChannelMembershipForAppInstanceUser in the Amazon Chime SDK Messaging NamespacedescribeChannelMembershipForAppInstanceUser
(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest) Deprecated.Replaced by DescribeChannelMembershipForAppInstanceUser in the Amazon Chime SDK Messaging NamespacedescribeChannelModeratedByAppInstanceUser
(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest) Deprecated.Replaced by DescribeChannelModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespacedescribeChannelModeratedByAppInstanceUser
(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest) Deprecated.Replaced by DescribeChannelModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespacedescribeChannelModerator
(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest) Deprecated.Replaced by DescribeChannelModerator in the Amazon Chime SDK Messaging NamespacedescribeChannelModerator
(DescribeChannelModeratorRequest describeChannelModeratorRequest) Deprecated.Replaced by DescribeChannelModerator in the Amazon Chime SDK Messaging NamespacedisassociatePhoneNumberFromUser
(Consumer<DisassociatePhoneNumberFromUserRequest.Builder> disassociatePhoneNumberFromUserRequest) Disassociates the primary provisioned phone number from the specified Amazon Chime user.disassociatePhoneNumberFromUser
(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest) Disassociates the primary provisioned phone number from the specified Amazon Chime user.disassociatePhoneNumbersFromVoiceConnector
(Consumer<DisassociatePhoneNumbersFromVoiceConnectorRequest.Builder> disassociatePhoneNumbersFromVoiceConnectorRequest) Deprecated.Replaced by DisassociatePhoneNumbersFromVoiceConnector in the Amazon Chime SDK Voice NamespacedisassociatePhoneNumbersFromVoiceConnector
(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest) Deprecated.Replaced by DisassociatePhoneNumbersFromVoiceConnector in the Amazon Chime SDK Voice NamespacedisassociatePhoneNumbersFromVoiceConnectorGroup
(Consumer<DisassociatePhoneNumbersFromVoiceConnectorGroupRequest.Builder> disassociatePhoneNumbersFromVoiceConnectorGroupRequest) Deprecated.Replaced by DisassociatePhoneNumbersFromVoiceConnectorGroup in the Amazon Chime SDK Voice NamespacedisassociatePhoneNumbersFromVoiceConnectorGroup
(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest disassociatePhoneNumbersFromVoiceConnectorGroupRequest) Deprecated.Replaced by DisassociatePhoneNumbersFromVoiceConnectorGroup in the Amazon Chime SDK Voice NamespacedisassociateSigninDelegateGroupsFromAccount
(Consumer<DisassociateSigninDelegateGroupsFromAccountRequest.Builder> disassociateSigninDelegateGroupsFromAccountRequest) Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.disassociateSigninDelegateGroupsFromAccount
(DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest) Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.default CompletableFuture
<GetAccountResponse> getAccount
(Consumer<GetAccountRequest.Builder> getAccountRequest) Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.default CompletableFuture
<GetAccountResponse> getAccount
(GetAccountRequest getAccountRequest) Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.getAccountSettings
(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest) Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.getAccountSettings
(GetAccountSettingsRequest getAccountSettingsRequest) Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.getAppInstanceRetentionSettings
(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest) Deprecated.Replaced by GetAppInstanceRetentionSettings in the Amazon Chime SDK Identity NamespacegetAppInstanceRetentionSettings
(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest) Deprecated.Replaced by GetAppInstanceRetentionSettings in the Amazon Chime SDK Identity NamespacegetAppInstanceStreamingConfigurations
(Consumer<GetAppInstanceStreamingConfigurationsRequest.Builder> getAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by GetAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespacegetAppInstanceStreamingConfigurations
(GetAppInstanceStreamingConfigurationsRequest getAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by GetAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<GetAttendeeResponse> getAttendee
(Consumer<GetAttendeeRequest.Builder> getAttendeeRequest) Deprecated.Replaced by GetAttendee in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<GetAttendeeResponse> getAttendee
(GetAttendeeRequest getAttendeeRequest) Deprecated.Replaced by GetAttendee in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<GetBotResponse> getBot
(Consumer<GetBotRequest.Builder> getBotRequest) Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.default CompletableFuture
<GetBotResponse> getBot
(GetBotRequest getBotRequest) Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.getChannelMessage
(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest) Deprecated.Replaced by GetChannelMessage in the Amazon Chime SDK Messaging NamespacegetChannelMessage
(GetChannelMessageRequest getChannelMessageRequest) Deprecated.Replaced by GetChannelMessage in the Amazon Chime SDK Messaging NamespacegetEventsConfiguration
(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.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.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.getGlobalSettings
(GetGlobalSettingsRequest getGlobalSettingsRequest) Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.getMediaCapturePipeline
(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest) Deprecated.Replaced by GetMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespacegetMediaCapturePipeline
(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest) Deprecated.Replaced by GetMediaCapturePipeline in the Amazon Chime SDK Media Pipelines Namespacedefault CompletableFuture
<GetMeetingResponse> getMeeting
(Consumer<GetMeetingRequest.Builder> getMeetingRequest) Deprecated.Replaced by GetMeeting in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<GetMeetingResponse> getMeeting
(GetMeetingRequest getMeetingRequest) Deprecated.Replaced by GetMeeting in the Amazon Chime SDK Meetings NamespacegetMessagingSessionEndpoint
(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest) Deprecated.Replaced by GetMessagingSessionEndpoint in the Amazon Chime SDK Messaging NamespacegetMessagingSessionEndpoint
(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest) Deprecated.Replaced by GetMessagingSessionEndpoint in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<GetPhoneNumberResponse> getPhoneNumber
(Consumer<GetPhoneNumberRequest.Builder> getPhoneNumberRequest) Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.default CompletableFuture
<GetPhoneNumberResponse> getPhoneNumber
(GetPhoneNumberRequest getPhoneNumberRequest) Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.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.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.getPhoneNumberSettings
(Consumer<GetPhoneNumberSettingsRequest.Builder> getPhoneNumberSettingsRequest) Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.getPhoneNumberSettings
(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest) Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.default CompletableFuture
<GetProxySessionResponse> getProxySession
(Consumer<GetProxySessionRequest.Builder> getProxySessionRequest) Deprecated.Replaced by GetProxySession in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<GetProxySessionResponse> getProxySession
(GetProxySessionRequest getProxySessionRequest) Deprecated.Replaced by GetProxySession in the Amazon Chime SDK Voice NamespacegetRetentionSettings
(Consumer<GetRetentionSettingsRequest.Builder> getRetentionSettingsRequest) Gets the retention settings for the specified Amazon Chime Enterprise account.getRetentionSettings
(GetRetentionSettingsRequest getRetentionSettingsRequest) Gets the retention settings for the specified Amazon Chime Enterprise account.default CompletableFuture
<GetRoomResponse> getRoom
(Consumer<GetRoomRequest.Builder> getRoomRequest) Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.default CompletableFuture
<GetRoomResponse> getRoom
(GetRoomRequest getRoomRequest) Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.getSipMediaApplication
(Consumer<GetSipMediaApplicationRequest.Builder> getSipMediaApplicationRequest) Deprecated.Replaced by GetSipMediaApplication in the Amazon Chime SDK Voice NamespacegetSipMediaApplication
(GetSipMediaApplicationRequest getSipMediaApplicationRequest) Deprecated.Replaced by GetSipMediaApplication in the Amazon Chime SDK Voice NamespacegetSipMediaApplicationLoggingConfiguration
(Consumer<GetSipMediaApplicationLoggingConfigurationRequest.Builder> getSipMediaApplicationLoggingConfigurationRequest) Deprecated.Replaced by GetSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice NamespacegetSipMediaApplicationLoggingConfiguration
(GetSipMediaApplicationLoggingConfigurationRequest getSipMediaApplicationLoggingConfigurationRequest) Deprecated.Replaced by GetSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<GetSipRuleResponse> getSipRule
(Consumer<GetSipRuleRequest.Builder> getSipRuleRequest) Deprecated.Replaced by GetSipRule in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<GetSipRuleResponse> getSipRule
(GetSipRuleRequest getSipRuleRequest) Deprecated.Replaced by GetSipRule in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<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 CompletableFuture
<GetUserResponse> getUser
(GetUserRequest getUserRequest) Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.default CompletableFuture
<GetUserSettingsResponse> getUserSettings
(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest) Retrieves settings for the specified user ID, such as any associated phone number settings.default CompletableFuture
<GetUserSettingsResponse> getUserSettings
(GetUserSettingsRequest getUserSettingsRequest) Retrieves settings for the specified user ID, such as any associated phone number settings.getVoiceConnector
(Consumer<GetVoiceConnectorRequest.Builder> getVoiceConnectorRequest) Deprecated.Replaced by GetVoiceConnector in the Amazon Chime SDK Voice NamespacegetVoiceConnector
(GetVoiceConnectorRequest getVoiceConnectorRequest) Deprecated.Replaced by GetVoiceConnector in the Amazon Chime SDK Voice NamespacegetVoiceConnectorEmergencyCallingConfiguration
(Consumer<GetVoiceConnectorEmergencyCallingConfigurationRequest.Builder> getVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespacegetVoiceConnectorEmergencyCallingConfiguration
(GetVoiceConnectorEmergencyCallingConfigurationRequest getVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespacegetVoiceConnectorGroup
(Consumer<GetVoiceConnectorGroupRequest.Builder> getVoiceConnectorGroupRequest) Deprecated.Replaced by GetVoiceConnectorGroup in the Amazon Chime SDK Voice NamespacegetVoiceConnectorGroup
(GetVoiceConnectorGroupRequest getVoiceConnectorGroupRequest) Deprecated.Replaced by GetVoiceConnectorGroup in the Amazon Chime SDK Voice NamespacegetVoiceConnectorLoggingConfiguration
(Consumer<GetVoiceConnectorLoggingConfigurationRequest.Builder> getVoiceConnectorLoggingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice NamespacegetVoiceConnectorLoggingConfiguration
(GetVoiceConnectorLoggingConfigurationRequest getVoiceConnectorLoggingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice NamespacegetVoiceConnectorOrigination
(Consumer<GetVoiceConnectorOriginationRequest.Builder> getVoiceConnectorOriginationRequest) Deprecated.Replaced by GetVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespacegetVoiceConnectorOrigination
(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest) Deprecated.Replaced by GetVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespacegetVoiceConnectorProxy
(Consumer<GetVoiceConnectorProxyRequest.Builder> getVoiceConnectorProxyRequest) Deprecated.Replaced by GetVoiceConnectorProxy in the Amazon Chime SDK Voice NamespacegetVoiceConnectorProxy
(GetVoiceConnectorProxyRequest getVoiceConnectorProxyRequest) Deprecated.Replaced by GetVoiceConnectorProxy in the Amazon Chime SDK Voice NamespacegetVoiceConnectorStreamingConfiguration
(Consumer<GetVoiceConnectorStreamingConfigurationRequest.Builder> getVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespacegetVoiceConnectorStreamingConfiguration
(GetVoiceConnectorStreamingConfigurationRequest getVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespacegetVoiceConnectorTermination
(Consumer<GetVoiceConnectorTerminationRequest.Builder> getVoiceConnectorTerminationRequest) Deprecated.Replaced by GetVoiceConnectorTermination in the Amazon Chime SDK Voice NamespacegetVoiceConnectorTermination
(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest) Deprecated.Replaced by GetVoiceConnectorTermination in the Amazon Chime SDK Voice NamespacegetVoiceConnectorTerminationHealth
(Consumer<GetVoiceConnectorTerminationHealthRequest.Builder> getVoiceConnectorTerminationHealthRequest) Deprecated.Replaced by GetVoiceConnectorTerminationHealth in the Amazon Chime SDK Voice NamespacegetVoiceConnectorTerminationHealth
(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest) Deprecated.Replaced by GetVoiceConnectorTerminationHealth in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<InviteUsersResponse> inviteUsers
(Consumer<InviteUsersRequest.Builder> inviteUsersRequest) Sends email to a maximum of 50 users, inviting them to the specified Amazon ChimeTeam
account.default CompletableFuture
<InviteUsersResponse> inviteUsers
(InviteUsersRequest inviteUsersRequest) Sends email to a maximum of 50 users, inviting them to the specified Amazon ChimeTeam
account.default CompletableFuture
<ListAccountsResponse> Lists the Amazon Chime accounts under the administrator's AWS account.default CompletableFuture
<ListAccountsResponse> listAccounts
(Consumer<ListAccountsRequest.Builder> listAccountsRequest) Lists the Amazon Chime accounts under the administrator's AWS account.default CompletableFuture
<ListAccountsResponse> listAccounts
(ListAccountsRequest listAccountsRequest) Lists the Amazon Chime accounts under the administrator's AWS account.default ListAccountsPublisher
This is a variant oflistAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation.default ListAccountsPublisher
listAccountsPaginator
(Consumer<ListAccountsRequest.Builder> listAccountsRequest) This is a variant oflistAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation.default ListAccountsPublisher
listAccountsPaginator
(ListAccountsRequest listAccountsRequest) This is a variant oflistAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation.listAppInstanceAdmins
(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) Deprecated.Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity NamespacelistAppInstanceAdmins
(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) Deprecated.Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity Namespacedefault ListAppInstanceAdminsPublisher
listAppInstanceAdminsPaginator
(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) Deprecated.Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity Namespacedefault ListAppInstanceAdminsPublisher
listAppInstanceAdminsPaginator
(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) Deprecated.Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity NamespacelistAppInstances
(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) Deprecated.Replaced by ListAppInstances in the Amazon Chime SDK Identity NamespacelistAppInstances
(ListAppInstancesRequest listAppInstancesRequest) Deprecated.Replaced by ListAppInstances in the Amazon Chime SDK Identity Namespacedefault ListAppInstancesPublisher
listAppInstancesPaginator
(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) Deprecated.Replaced by ListAppInstances in the Amazon Chime SDK Identity Namespacedefault ListAppInstancesPublisher
listAppInstancesPaginator
(ListAppInstancesRequest listAppInstancesRequest) Deprecated.Replaced by ListAppInstances in the Amazon Chime SDK Identity NamespacelistAppInstanceUsers
(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) Deprecated.Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity NamespacelistAppInstanceUsers
(ListAppInstanceUsersRequest listAppInstanceUsersRequest) Deprecated.Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity Namespacedefault ListAppInstanceUsersPublisher
listAppInstanceUsersPaginator
(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) Deprecated.Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity Namespacedefault ListAppInstanceUsersPublisher
listAppInstanceUsersPaginator
(ListAppInstanceUsersRequest listAppInstanceUsersRequest) Deprecated.Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity Namespacedefault CompletableFuture
<ListAttendeesResponse> listAttendees
(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) Deprecated.Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<ListAttendeesResponse> listAttendees
(ListAttendeesRequest listAttendeesRequest) Deprecated.Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespacedefault ListAttendeesPublisher
listAttendeesPaginator
(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) Deprecated.Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespacedefault ListAttendeesPublisher
listAttendeesPaginator
(ListAttendeesRequest listAttendeesRequest) Deprecated.Replaced by ListAttendees in the Amazon Chime SDK Meetings NamespacelistAttendeeTags
(Consumer<ListAttendeeTagsRequest.Builder> listAttendeeTagsRequest) Deprecated.Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace.listAttendeeTags
(ListAttendeeTagsRequest listAttendeeTagsRequest) Deprecated.Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<ListBotsResponse> listBots
(Consumer<ListBotsRequest.Builder> listBotsRequest) Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.default CompletableFuture
<ListBotsResponse> listBots
(ListBotsRequest listBotsRequest) Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.default ListBotsPublisher
listBotsPaginator
(Consumer<ListBotsRequest.Builder> listBotsRequest) This is a variant oflistBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)
operation.default ListBotsPublisher
listBotsPaginator
(ListBotsRequest listBotsRequest) This is a variant oflistBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)
operation.default CompletableFuture
<ListChannelBansResponse> listChannelBans
(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) Deprecated.Replaced by ListChannelBans in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<ListChannelBansResponse> listChannelBans
(ListChannelBansRequest listChannelBansRequest) Deprecated.Replaced by ListChannelBans in the Amazon Chime SDK Messaging Namespacedefault ListChannelBansPublisher
listChannelBansPaginator
(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) Deprecated.Replaced by ListChannelBans in the Amazon Chime SDK Messaging Namespacedefault ListChannelBansPublisher
listChannelBansPaginator
(ListChannelBansRequest listChannelBansRequest) Deprecated.Replaced by ListChannelBans in the Amazon Chime SDK Messaging NamespacelistChannelMemberships
(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) Deprecated.Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging NamespacelistChannelMemberships
(ListChannelMembershipsRequest listChannelMembershipsRequest) Deprecated.Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging NamespacelistChannelMembershipsForAppInstanceUser
(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) Deprecated.Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging NamespacelistChannelMembershipsForAppInstanceUser
(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) Deprecated.Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging NamespacelistChannelMembershipsForAppInstanceUserPaginator
(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) Deprecated.Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging NamespacelistChannelMembershipsForAppInstanceUserPaginator
(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) Deprecated.Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging Namespacedefault ListChannelMembershipsPublisher
listChannelMembershipsPaginator
(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) Deprecated.Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging Namespacedefault ListChannelMembershipsPublisher
listChannelMembershipsPaginator
(ListChannelMembershipsRequest listChannelMembershipsRequest) Deprecated.Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging NamespacelistChannelMessages
(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) Deprecated.Replaced by ListChannelMessages in the Amazon Chime SDK Messaging NamespacelistChannelMessages
(ListChannelMessagesRequest listChannelMessagesRequest) Deprecated.Replaced by ListChannelMessages in the Amazon Chime SDK Messaging Namespacedefault ListChannelMessagesPublisher
listChannelMessagesPaginator
(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) Deprecated.Replaced by ListChannelMessages in the Amazon Chime SDK Messaging Namespacedefault ListChannelMessagesPublisher
listChannelMessagesPaginator
(ListChannelMessagesRequest listChannelMessagesRequest) Deprecated.Replaced by ListChannelMessages in the Amazon Chime SDK Messaging NamespacelistChannelModerators
(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) Deprecated.Replaced by ListChannelModerators in the Amazon Chime SDK Messaging NamespacelistChannelModerators
(ListChannelModeratorsRequest listChannelModeratorsRequest) Deprecated.Replaced by ListChannelModerators in the Amazon Chime SDK Messaging Namespacedefault ListChannelModeratorsPublisher
listChannelModeratorsPaginator
(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) Deprecated.Replaced by ListChannelModerators in the Amazon Chime SDK Messaging Namespacedefault ListChannelModeratorsPublisher
listChannelModeratorsPaginator
(ListChannelModeratorsRequest listChannelModeratorsRequest) Deprecated.Replaced by ListChannelModerators in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<ListChannelsResponse> listChannels
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Deprecated.Replaced by ListChannels in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<ListChannelsResponse> listChannels
(ListChannelsRequest listChannelsRequest) Deprecated.Replaced by ListChannels in the Amazon Chime SDK Messaging NamespacelistChannelsModeratedByAppInstanceUser
(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) Deprecated.Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespacelistChannelsModeratedByAppInstanceUser
(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) Deprecated.Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespacelistChannelsModeratedByAppInstanceUserPaginator
(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) Deprecated.Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespacelistChannelsModeratedByAppInstanceUserPaginator
(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) Deprecated.Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging Namespacedefault ListChannelsPublisher
listChannelsPaginator
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Deprecated.Replaced by ListChannels in the Amazon Chime SDK Messaging Namespacedefault ListChannelsPublisher
listChannelsPaginator
(ListChannelsRequest listChannelsRequest) Deprecated.Replaced by ListChannels in the Amazon Chime SDK Messaging NamespacelistMediaCapturePipelines
(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) Deprecated.Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines NamespacelistMediaCapturePipelines
(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Deprecated.Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines NamespacelistMediaCapturePipelinesPaginator
(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) Deprecated.Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines NamespacelistMediaCapturePipelinesPaginator
(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Deprecated.Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines Namespacedefault CompletableFuture
<ListMeetingsResponse> listMeetings
(Consumer<ListMeetingsRequest.Builder> listMeetingsRequest) Deprecated.ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<ListMeetingsResponse> listMeetings
(ListMeetingsRequest listMeetingsRequest) Deprecated.ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace.default ListMeetingsPublisher
listMeetingsPaginator
(Consumer<ListMeetingsRequest.Builder> listMeetingsRequest) Deprecated.ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace.default ListMeetingsPublisher
listMeetingsPaginator
(ListMeetingsRequest listMeetingsRequest) Deprecated.ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<ListMeetingTagsResponse> listMeetingTags
(Consumer<ListMeetingTagsRequest.Builder> listMeetingTagsRequest) Deprecated.Use ListTagsForResource in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<ListMeetingTagsResponse> listMeetingTags
(ListMeetingTagsRequest listMeetingTagsRequest) Deprecated.Use ListTagsForResource in the Amazon Chime SDK Meetings Namespace.listPhoneNumberOrders
(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) Lists the phone number orders for the administrator's Amazon Chime account.listPhoneNumberOrders
(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) Lists the phone number orders for the administrator's Amazon Chime account.default ListPhoneNumberOrdersPublisher
listPhoneNumberOrdersPaginator
(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) This is a variant oflistPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)
operation.default ListPhoneNumberOrdersPublisher
listPhoneNumberOrdersPaginator
(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) This is a variant oflistPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)
operation.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.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 ListPhoneNumbersPublisher
listPhoneNumbersPaginator
(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) This is a variant oflistPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)
operation.default ListPhoneNumbersPublisher
listPhoneNumbersPaginator
(ListPhoneNumbersRequest listPhoneNumbersRequest) This is a variant oflistPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)
operation.listProxySessions
(Consumer<ListProxySessionsRequest.Builder> listProxySessionsRequest) Deprecated.Replaced by ListProxySessions in the Amazon Chime SDK Voice NamespacelistProxySessions
(ListProxySessionsRequest listProxySessionsRequest) Deprecated.Replaced by ListProxySessions in the Amazon Chime SDK Voice Namespacedefault ListProxySessionsPublisher
listProxySessionsPaginator
(Consumer<ListProxySessionsRequest.Builder> listProxySessionsRequest) Deprecated.Replaced by ListProxySessions in the Amazon Chime SDK Voice Namespacedefault ListProxySessionsPublisher
listProxySessionsPaginator
(ListProxySessionsRequest listProxySessionsRequest) Deprecated.Replaced by ListProxySessions in the Amazon Chime SDK Voice NamespacelistRoomMemberships
(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.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 ListRoomMembershipsPublisher
listRoomMembershipsPaginator
(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest) This is a variant oflistRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)
operation.default ListRoomMembershipsPublisher
listRoomMembershipsPaginator
(ListRoomMembershipsRequest listRoomMembershipsRequest) This is a variant oflistRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)
operation.default CompletableFuture
<ListRoomsResponse> listRooms
(Consumer<ListRoomsRequest.Builder> listRoomsRequest) Lists the room details for the specified Amazon Chime Enterprise account.default CompletableFuture
<ListRoomsResponse> listRooms
(ListRoomsRequest listRoomsRequest) Lists the room details for the specified Amazon Chime Enterprise account.default ListRoomsPublisher
listRoomsPaginator
(Consumer<ListRoomsRequest.Builder> listRoomsRequest) This is a variant oflistRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)
operation.default ListRoomsPublisher
listRoomsPaginator
(ListRoomsRequest listRoomsRequest) This is a variant oflistRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)
operation.listSipMediaApplications
(Consumer<ListSipMediaApplicationsRequest.Builder> listSipMediaApplicationsRequest) Deprecated.Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice NamespacelistSipMediaApplications
(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest) Deprecated.Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice NamespacelistSipMediaApplicationsPaginator
(Consumer<ListSipMediaApplicationsRequest.Builder> listSipMediaApplicationsRequest) Deprecated.Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice NamespacelistSipMediaApplicationsPaginator
(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest) Deprecated.Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<ListSipRulesResponse> listSipRules
(Consumer<ListSipRulesRequest.Builder> listSipRulesRequest) Deprecated.Replaced by ListSipRules in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<ListSipRulesResponse> listSipRules
(ListSipRulesRequest listSipRulesRequest) Deprecated.Replaced by ListSipRules in the Amazon Chime SDK Voice Namespacedefault ListSipRulesPublisher
listSipRulesPaginator
(Consumer<ListSipRulesRequest.Builder> listSipRulesRequest) Deprecated.Replaced by ListSipRules in the Amazon Chime SDK Voice Namespacedefault ListSipRulesPublisher
listSipRulesPaginator
(ListSipRulesRequest listSipRulesRequest) Deprecated.Replaced by ListSipRules in the Amazon Chime SDK Voice NamespacelistSupportedPhoneNumberCountries
(Consumer<ListSupportedPhoneNumberCountriesRequest.Builder> listSupportedPhoneNumberCountriesRequest) Lists supported phone number countries.listSupportedPhoneNumberCountries
(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest) Lists supported phone number countries.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 NamespaceslistTagsForResource
(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 Namespacesdefault CompletableFuture
<ListUsersResponse> listUsers
(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists the users that belong to the specified Amazon Chime account.default CompletableFuture
<ListUsersResponse> listUsers
(ListUsersRequest listUsersRequest) Lists the users that belong to the specified Amazon Chime account.default ListUsersPublisher
listUsersPaginator
(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)
operation.default ListUsersPublisher
listUsersPaginator
(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)
operation.listVoiceConnectorGroups
(Consumer<ListVoiceConnectorGroupsRequest.Builder> listVoiceConnectorGroupsRequest) Deprecated.Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice NamespacelistVoiceConnectorGroups
(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest) Deprecated.Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice NamespacelistVoiceConnectorGroupsPaginator
(Consumer<ListVoiceConnectorGroupsRequest.Builder> listVoiceConnectorGroupsRequest) Deprecated.Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice NamespacelistVoiceConnectorGroupsPaginator
(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest) Deprecated.Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice NamespacelistVoiceConnectors
(Consumer<ListVoiceConnectorsRequest.Builder> listVoiceConnectorsRequest) Deprecated.Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice NamespacelistVoiceConnectors
(ListVoiceConnectorsRequest listVoiceConnectorsRequest) Deprecated.Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice Namespacedefault ListVoiceConnectorsPublisher
listVoiceConnectorsPaginator
(Consumer<ListVoiceConnectorsRequest.Builder> listVoiceConnectorsRequest) Deprecated.Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice Namespacedefault ListVoiceConnectorsPublisher
listVoiceConnectorsPaginator
(ListVoiceConnectorsRequest listVoiceConnectorsRequest) Deprecated.Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice NamespacelistVoiceConnectorTerminationCredentials
(Consumer<ListVoiceConnectorTerminationCredentialsRequest.Builder> listVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by ListVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespacelistVoiceConnectorTerminationCredentials
(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by ListVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<LogoutUserResponse> logoutUser
(Consumer<LogoutUserRequest.Builder> logoutUserRequest) Logs out the specified user from all of the devices they are currently logged into.default CompletableFuture
<LogoutUserResponse> logoutUser
(LogoutUserRequest logoutUserRequest) Logs out the specified user from all of the devices they are currently logged into.putAppInstanceRetentionSettings
(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest) Deprecated.Replaced by PutAppInstanceRetentionSettings in the Amazon Chime SDK Identity NamespaceputAppInstanceRetentionSettings
(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) Deprecated.Replaced by PutAppInstanceRetentionSettings in the Amazon Chime SDK Identity NamespaceputAppInstanceStreamingConfigurations
(Consumer<PutAppInstanceStreamingConfigurationsRequest.Builder> putAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by PutAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespaceputAppInstanceStreamingConfigurations
(PutAppInstanceStreamingConfigurationsRequest putAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by PutAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespaceputEventsConfiguration
(Consumer<PutEventsConfigurationRequest.Builder> putEventsConfigurationRequest) Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.putEventsConfiguration
(PutEventsConfigurationRequest putEventsConfigurationRequest) Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.putRetentionSettings
(Consumer<PutRetentionSettingsRequest.Builder> putRetentionSettingsRequest) Puts retention settings for the specified Amazon Chime Enterprise account.putRetentionSettings
(PutRetentionSettingsRequest putRetentionSettingsRequest) Puts retention settings for the specified Amazon Chime Enterprise account.putSipMediaApplicationLoggingConfiguration
(Consumer<PutSipMediaApplicationLoggingConfigurationRequest.Builder> putSipMediaApplicationLoggingConfigurationRequest) Deprecated.Replaced by PutSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice NamespaceputSipMediaApplicationLoggingConfiguration
(PutSipMediaApplicationLoggingConfigurationRequest putSipMediaApplicationLoggingConfigurationRequest) Deprecated.Replaced by PutSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice NamespaceputVoiceConnectorEmergencyCallingConfiguration
(Consumer<PutVoiceConnectorEmergencyCallingConfigurationRequest.Builder> putVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespaceputVoiceConnectorEmergencyCallingConfiguration
(PutVoiceConnectorEmergencyCallingConfigurationRequest putVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespaceputVoiceConnectorLoggingConfiguration
(Consumer<PutVoiceConnectorLoggingConfigurationRequest.Builder> putVoiceConnectorLoggingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice NamespaceputVoiceConnectorLoggingConfiguration
(PutVoiceConnectorLoggingConfigurationRequest putVoiceConnectorLoggingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice NamespaceputVoiceConnectorOrigination
(Consumer<PutVoiceConnectorOriginationRequest.Builder> putVoiceConnectorOriginationRequest) Deprecated.Replaced by PutVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespaceputVoiceConnectorOrigination
(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest) Deprecated.Replaced by PutVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespaceputVoiceConnectorProxy
(Consumer<PutVoiceConnectorProxyRequest.Builder> putVoiceConnectorProxyRequest) Deprecated.Replaced by PutVoiceConnectorProxy in the Amazon Chime SDK Voice NamespaceputVoiceConnectorProxy
(PutVoiceConnectorProxyRequest putVoiceConnectorProxyRequest) Deprecated.Replaced by PutVoiceConnectorProxy in the Amazon Chime SDK Voice NamespaceputVoiceConnectorStreamingConfiguration
(Consumer<PutVoiceConnectorStreamingConfigurationRequest.Builder> putVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespaceputVoiceConnectorStreamingConfiguration
(PutVoiceConnectorStreamingConfigurationRequest putVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespaceputVoiceConnectorTermination
(Consumer<PutVoiceConnectorTerminationRequest.Builder> putVoiceConnectorTerminationRequest) Deprecated.Replaced by PutVoiceConnectorTermination in the Amazon Chime SDK Voice NamespaceputVoiceConnectorTermination
(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest) Deprecated.Replaced by PutVoiceConnectorTermination in the Amazon Chime SDK Voice NamespaceputVoiceConnectorTerminationCredentials
(Consumer<PutVoiceConnectorTerminationCredentialsRequest.Builder> putVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by PutVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespaceputVoiceConnectorTerminationCredentials
(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by PutVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespaceredactChannelMessage
(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest) Deprecated.Replaced by RedactChannelMessage in the Amazon Chime SDK Messaging NamespaceredactChannelMessage
(RedactChannelMessageRequest redactChannelMessageRequest) Deprecated.Replaced by RedactChannelMessage in the Amazon Chime SDK Messaging NamespaceredactConversationMessage
(Consumer<RedactConversationMessageRequest.Builder> redactConversationMessageRequest) Redacts the specified message from the specified Amazon Chime conversation.redactConversationMessage
(RedactConversationMessageRequest redactConversationMessageRequest) Redacts the specified message from the specified Amazon Chime conversation.redactRoomMessage
(Consumer<RedactRoomMessageRequest.Builder> redactRoomMessageRequest) Redacts the specified message from the specified Amazon Chime channel.redactRoomMessage
(RedactRoomMessageRequest redactRoomMessageRequest) Redacts the specified message from the specified Amazon Chime channel.regenerateSecurityToken
(Consumer<RegenerateSecurityTokenRequest.Builder> regenerateSecurityTokenRequest) Regenerates the security token for a bot.regenerateSecurityToken
(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest) Regenerates the security token for a bot.resetPersonalPIN
(Consumer<ResetPersonalPinRequest.Builder> resetPersonalPinRequest) Resets the personal meeting PIN for the specified user on an Amazon Chime account.resetPersonalPIN
(ResetPersonalPinRequest resetPersonalPinRequest) Resets the personal meeting PIN for the specified user on an Amazon Chime account.restorePhoneNumber
(Consumer<RestorePhoneNumberRequest.Builder> restorePhoneNumberRequest) Moves a phone number from the Deletion queue back into the phone number Inventory.restorePhoneNumber
(RestorePhoneNumberRequest restorePhoneNumberRequest) Moves a phone number from the Deletion queue back into the phone number Inventory.searchAvailablePhoneNumbers
(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) Searches for phone numbers that can be ordered.searchAvailablePhoneNumbers
(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) Searches for phone numbers that can be ordered.searchAvailablePhoneNumbersPaginator
(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) This is a variant ofsearchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)
operation.searchAvailablePhoneNumbersPaginator
(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) This is a variant ofsearchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)
operation.sendChannelMessage
(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest) Deprecated.Replaced by SendChannelMessage in the Amazon Chime SDK Messaging NamespacesendChannelMessage
(SendChannelMessageRequest sendChannelMessageRequest) Deprecated.Replaced by SendChannelMessage in the Amazon Chime SDK Messaging Namespacedefault ChimeServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartMeetingTranscription
(Consumer<StartMeetingTranscriptionRequest.Builder> startMeetingTranscriptionRequest) Deprecated.Replaced by StartMeetingTranscription in the Amazon Chime SDK Meetings NamespacestartMeetingTranscription
(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest) Deprecated.Replaced by StartMeetingTranscription in the Amazon Chime SDK Meetings NamespacestopMeetingTranscription
(Consumer<StopMeetingTranscriptionRequest.Builder> stopMeetingTranscriptionRequest) Deprecated.Replaced by StopMeetingTranscription in the Amazon Chime SDK Meetings NamespacestopMeetingTranscription
(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest) Deprecated.Replaced by StopMeetingTranscription in the Amazon Chime SDK Meetings Namespacedefault CompletableFuture
<TagAttendeeResponse> tagAttendee
(Consumer<TagAttendeeRequest.Builder> tagAttendeeRequest) Deprecated.Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<TagAttendeeResponse> tagAttendee
(TagAttendeeRequest tagAttendeeRequest) Deprecated.Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<TagMeetingResponse> tagMeeting
(Consumer<TagMeetingRequest.Builder> tagMeetingRequest) Deprecated.Use TagResource in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<TagMeetingResponse> tagMeeting
(TagMeetingRequest tagMeetingRequest) Deprecated.Use TagResource in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<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 Namespacesdefault CompletableFuture
<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 Namespacesdefault CompletableFuture
<UntagAttendeeResponse> untagAttendee
(Consumer<UntagAttendeeRequest.Builder> untagAttendeeRequest) Deprecated.Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<UntagAttendeeResponse> untagAttendee
(UntagAttendeeRequest untagAttendeeRequest) Deprecated.Attendee Tags are not supported in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<UntagMeetingResponse> untagMeeting
(Consumer<UntagMeetingRequest.Builder> untagMeetingRequest) Deprecated.Use UntagResource in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<UntagMeetingResponse> untagMeeting
(UntagMeetingRequest untagMeetingRequest) Deprecated.Use UntagResource in the Amazon Chime SDK Meetings Namespace.default CompletableFuture
<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 Namespacesdefault CompletableFuture
<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 Namespacesdefault CompletableFuture
<UpdateAccountResponse> updateAccount
(Consumer<UpdateAccountRequest.Builder> updateAccountRequest) Updates account details for the specified Amazon Chime account.default CompletableFuture
<UpdateAccountResponse> updateAccount
(UpdateAccountRequest updateAccountRequest) Updates account details for the specified Amazon Chime account.updateAccountSettings
(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) Updates the settings for the specified Amazon Chime account.updateAccountSettings
(UpdateAccountSettingsRequest updateAccountSettingsRequest) Updates the settings for the specified Amazon Chime account.updateAppInstance
(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest) Deprecated.Replaced by UpdateAppInstance in the Amazon Chime SDK Identity NamespaceupdateAppInstance
(UpdateAppInstanceRequest updateAppInstanceRequest) Deprecated.Replaced by UpdateAppInstance in the Amazon Chime SDK Identity NamespaceupdateAppInstanceUser
(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest) Deprecated.Replaced by UpdateAppInstanceUser in the Amazon Chime SDK Identity NamespaceupdateAppInstanceUser
(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) Deprecated.Replaced by UpdateAppInstanceUser in the Amazon Chime SDK Identity Namespacedefault CompletableFuture
<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 CompletableFuture
<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 CompletableFuture
<UpdateChannelResponse> updateChannel
(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Deprecated.Replaced by UpdateChannel in the Amazon Chime SDK Messaging Namespacedefault CompletableFuture
<UpdateChannelResponse> updateChannel
(UpdateChannelRequest updateChannelRequest) Deprecated.Replaced by UpdateChannel in the Amazon Chime SDK Messaging NamespaceupdateChannelMessage
(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest) Deprecated.Replaced by UpdateChannelMessage in the Amazon Chime SDK Messaging NamespaceupdateChannelMessage
(UpdateChannelMessageRequest updateChannelMessageRequest) Deprecated.Replaced by UpdateChannelMessage in the Amazon Chime SDK Messaging NamespaceupdateChannelReadMarker
(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest) Deprecated.Replaced by UpdateChannelReadMarker in the Amazon Chime SDK Messaging NamespaceupdateChannelReadMarker
(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest) Deprecated.Replaced by UpdateChannelReadMarker in the Amazon Chime SDK Messaging NamespaceupdateGlobalSettings
(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.updateGlobalSettings
(UpdateGlobalSettingsRequest updateGlobalSettingsRequest) Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.updatePhoneNumber
(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) Updates phone number details, such as product type or calling name, for the specified phone number ID.updatePhoneNumber
(UpdatePhoneNumberRequest updatePhoneNumberRequest) Updates phone number details, such as product type or calling name, for the specified phone number ID.updatePhoneNumberSettings
(Consumer<UpdatePhoneNumberSettingsRequest.Builder> updatePhoneNumberSettingsRequest) Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.updatePhoneNumberSettings
(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest) Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.updateProxySession
(Consumer<UpdateProxySessionRequest.Builder> updateProxySessionRequest) Deprecated.Replaced by UpdateProxySession in the Amazon Chime SDK Voice NamespaceupdateProxySession
(UpdateProxySessionRequest updateProxySessionRequest) Deprecated.Replaced by UpdateProxySession in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<UpdateRoomResponse> updateRoom
(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.default CompletableFuture
<UpdateRoomResponse> updateRoom
(UpdateRoomRequest updateRoomRequest) Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.updateRoomMembership
(Consumer<UpdateRoomMembershipRequest.Builder> updateRoomMembershipRequest) Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.updateRoomMembership
(UpdateRoomMembershipRequest updateRoomMembershipRequest) Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.updateSipMediaApplication
(Consumer<UpdateSipMediaApplicationRequest.Builder> updateSipMediaApplicationRequest) Deprecated.Replaced by UpdateSipMediaApplication in the Amazon Chime SDK Voice NamespaceupdateSipMediaApplication
(UpdateSipMediaApplicationRequest updateSipMediaApplicationRequest) Deprecated.Replaced by UpdateSipMediaApplication in the Amazon Chime SDK Voice NamespaceupdateSipMediaApplicationCall
(Consumer<UpdateSipMediaApplicationCallRequest.Builder> updateSipMediaApplicationCallRequest) Deprecated.Replaced by UpdateSipMediaApplicationCall in the Amazon Chime SDK Voice NamespaceupdateSipMediaApplicationCall
(UpdateSipMediaApplicationCallRequest updateSipMediaApplicationCallRequest) Deprecated.Replaced by UpdateSipMediaApplicationCall in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<UpdateSipRuleResponse> updateSipRule
(Consumer<UpdateSipRuleRequest.Builder> updateSipRuleRequest) Deprecated.Replaced by UpdateSipRule in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<UpdateSipRuleResponse> updateSipRule
(UpdateSipRuleRequest updateSipRuleRequest) Deprecated.Replaced by UpdateSipRule in the Amazon Chime SDK Voice Namespacedefault CompletableFuture
<UpdateUserResponse> updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates user details for a specified user ID.default CompletableFuture
<UpdateUserResponse> updateUser
(UpdateUserRequest updateUserRequest) Updates user details for a specified user ID.updateUserSettings
(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest) Updates the settings for the specified user, such as phone number settings.updateUserSettings
(UpdateUserSettingsRequest updateUserSettingsRequest) Updates the settings for the specified user, such as phone number settings.updateVoiceConnector
(Consumer<UpdateVoiceConnectorRequest.Builder> updateVoiceConnectorRequest) Deprecated.Replaced by UpdateVoiceConnector in the Amazon Chime SDK Voice NamespaceupdateVoiceConnector
(UpdateVoiceConnectorRequest updateVoiceConnectorRequest) Deprecated.Replaced by UpdateVoiceConnector in the Amazon Chime SDK Voice NamespaceupdateVoiceConnectorGroup
(Consumer<UpdateVoiceConnectorGroupRequest.Builder> updateVoiceConnectorGroupRequest) Deprecated.Replaced by UpdateVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceupdateVoiceConnectorGroup
(UpdateVoiceConnectorGroupRequest updateVoiceConnectorGroupRequest) Deprecated.Replaced by UpdateVoiceConnectorGroup in the Amazon Chime SDK Voice NamespacevalidateE911Address
(Consumer<ValidateE911AddressRequest.Builder> validateE911AddressRequest) Deprecated.Replaced by ValidateE911Address in the Amazon Chime SDK Voice NamespacevalidateE911Address
(ValidateE911AddressRequest validateE911AddressRequest) Deprecated.Replaced by ValidateE911Address in the Amazon Chime SDK Voice NamespaceMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associatePhoneNumberWithUser
default CompletableFuture<AssociatePhoneNumberWithUserResponse> associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest) Associates a phone number with the specified Amazon Chime user.
- Parameters:
associatePhoneNumberWithUserRequest
-- Returns:
- A Java Future containing the result of the AssociatePhoneNumberWithUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
associatePhoneNumberWithUser
default CompletableFuture<AssociatePhoneNumberWithUserResponse> associatePhoneNumberWithUser(Consumer<AssociatePhoneNumberWithUserRequest.Builder> associatePhoneNumberWithUserRequest) 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 viaAssociatePhoneNumberWithUserRequest.builder()
- Parameters:
associatePhoneNumberWithUserRequest
- AConsumer
that will call methods onAssociatePhoneNumberWithUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociatePhoneNumberWithUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
associatePhoneNumbersWithVoiceConnector
@Deprecated default CompletableFuture<AssociatePhoneNumbersWithVoiceConnectorResponse> associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest) Deprecated.Replaced by AssociatePhoneNumbersWithVoiceConnector in the Amazon Chime SDK Voice NamespaceAssociates 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.
- Parameters:
associatePhoneNumbersWithVoiceConnectorRequest
-- Returns:
- A Java Future containing the result of the AssociatePhoneNumbersWithVoiceConnector operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
associatePhoneNumbersWithVoiceConnector
@Deprecated default CompletableFuture<AssociatePhoneNumbersWithVoiceConnectorResponse> associatePhoneNumbersWithVoiceConnector(Consumer<AssociatePhoneNumbersWithVoiceConnectorRequest.Builder> associatePhoneNumbersWithVoiceConnectorRequest) Deprecated.Replaced by AssociatePhoneNumbersWithVoiceConnector in the Amazon Chime SDK Voice NamespaceAssociates 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 viaAssociatePhoneNumbersWithVoiceConnectorRequest.builder()
- Parameters:
associatePhoneNumbersWithVoiceConnectorRequest
- AConsumer
that will call methods onAssociatePhoneNumbersWithVoiceConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociatePhoneNumbersWithVoiceConnector operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
associatePhoneNumbersWithVoiceConnectorGroup
@Deprecated default CompletableFuture<AssociatePhoneNumbersWithVoiceConnectorGroupResponse> associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest associatePhoneNumbersWithVoiceConnectorGroupRequest) Deprecated.Replaced by AssociatePhoneNumbersWithVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceAssociates 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.
- Parameters:
associatePhoneNumbersWithVoiceConnectorGroupRequest
-- Returns:
- A Java Future containing the result of the AssociatePhoneNumbersWithVoiceConnectorGroup operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
associatePhoneNumbersWithVoiceConnectorGroup
@Deprecated default CompletableFuture<AssociatePhoneNumbersWithVoiceConnectorGroupResponse> associatePhoneNumbersWithVoiceConnectorGroup(Consumer<AssociatePhoneNumbersWithVoiceConnectorGroupRequest.Builder> associatePhoneNumbersWithVoiceConnectorGroupRequest) Deprecated.Replaced by AssociatePhoneNumbersWithVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceAssociates 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 viaAssociatePhoneNumbersWithVoiceConnectorGroupRequest.builder()
- Parameters:
associatePhoneNumbersWithVoiceConnectorGroupRequest
- AConsumer
that will call methods onAssociatePhoneNumbersWithVoiceConnectorGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociatePhoneNumbersWithVoiceConnectorGroup operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
associateSigninDelegateGroupsWithAccount
default CompletableFuture<AssociateSigninDelegateGroupsWithAccountResponse> associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest) Associates the specified sign-in delegate groups with the specified Amazon Chime account.
- Parameters:
associateSigninDelegateGroupsWithAccountRequest
-- Returns:
- A Java Future containing the result of the AssociateSigninDelegateGroupsWithAccount operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
associateSigninDelegateGroupsWithAccount
default CompletableFuture<AssociateSigninDelegateGroupsWithAccountResponse> associateSigninDelegateGroupsWithAccount(Consumer<AssociateSigninDelegateGroupsWithAccountRequest.Builder> associateSigninDelegateGroupsWithAccountRequest) 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 viaAssociateSigninDelegateGroupsWithAccountRequest.builder()
- Parameters:
associateSigninDelegateGroupsWithAccountRequest
- AConsumer
that will call methods onAssociateSigninDelegateGroupsWithAccountRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateSigninDelegateGroupsWithAccount operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchCreateAttendee
@Deprecated default CompletableFuture<BatchCreateAttendeeResponse> batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest) Deprecated.Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings NamespaceCreates 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.
- Parameters:
batchCreateAttendeeRequest
-- Returns:
- A Java Future containing the result of the BatchCreateAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchCreateAttendee
@Deprecated default CompletableFuture<BatchCreateAttendeeResponse> batchCreateAttendee(Consumer<BatchCreateAttendeeRequest.Builder> batchCreateAttendeeRequest) Deprecated.Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings NamespaceCreates 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 viaBatchCreateAttendeeRequest.builder()
- Parameters:
batchCreateAttendeeRequest
- AConsumer
that will call methods onBatchCreateAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchCreateAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchCreateChannelMembership
@Deprecated default CompletableFuture<BatchCreateChannelMembershipResponse> batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest) Deprecated.Replaced by BatchCreateChannelMembership in the Amazon Chime SDK Messaging NamespaceAdds 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.
- Parameters:
batchCreateChannelMembershipRequest
-- Returns:
- A Java Future containing the result of the BatchCreateChannelMembership operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchCreateChannelMembership
@Deprecated default CompletableFuture<BatchCreateChannelMembershipResponse> batchCreateChannelMembership(Consumer<BatchCreateChannelMembershipRequest.Builder> batchCreateChannelMembershipRequest) Deprecated.Replaced by BatchCreateChannelMembership in the Amazon Chime SDK Messaging NamespaceAdds 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 viaBatchCreateChannelMembershipRequest.builder()
- Parameters:
batchCreateChannelMembershipRequest
- AConsumer
that will call methods onBatchCreateChannelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchCreateChannelMembership operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchCreateRoomMembership
default CompletableFuture<BatchCreateRoomMembershipResponse> batchCreateRoomMembership(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest) 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.
- Parameters:
batchCreateRoomMembershipRequest
-- Returns:
- A Java Future containing the result of the BatchCreateRoomMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchCreateRoomMembership
default CompletableFuture<BatchCreateRoomMembershipResponse> batchCreateRoomMembership(Consumer<BatchCreateRoomMembershipRequest.Builder> batchCreateRoomMembershipRequest) 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 viaBatchCreateRoomMembershipRequest.builder()
- Parameters:
batchCreateRoomMembershipRequest
- AConsumer
that will call methods onBatchCreateRoomMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchCreateRoomMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchDeletePhoneNumber
default CompletableFuture<BatchDeletePhoneNumberResponse> batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest) 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.
- Parameters:
batchDeletePhoneNumberRequest
-- Returns:
- A Java Future containing the result of the BatchDeletePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchDeletePhoneNumber
default CompletableFuture<BatchDeletePhoneNumberResponse> batchDeletePhoneNumber(Consumer<BatchDeletePhoneNumberRequest.Builder> batchDeletePhoneNumberRequest) 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 viaBatchDeletePhoneNumberRequest.builder()
- Parameters:
batchDeletePhoneNumberRequest
- AConsumer
that will call methods onBatchDeletePhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDeletePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchSuspendUser
default CompletableFuture<BatchSuspendUserResponse> batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest) Suspends up to 50 users from a
Team
orEnterpriseLWA
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 suspendedTeam
account users, invite them to theTeam
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 suspendedEnterpriseLWA
account users, use the BatchUnsuspendUser action.To sign out users without suspending them, use the LogoutUser action.
- Parameters:
batchSuspendUserRequest
-- Returns:
- A Java Future containing the result of the BatchSuspendUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchSuspendUser
default CompletableFuture<BatchSuspendUserResponse> batchSuspendUser(Consumer<BatchSuspendUserRequest.Builder> batchSuspendUserRequest) Suspends up to 50 users from a
Team
orEnterpriseLWA
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 suspendedTeam
account users, invite them to theTeam
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 suspendedEnterpriseLWA
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 viaBatchSuspendUserRequest.builder()
- Parameters:
batchSuspendUserRequest
- AConsumer
that will call methods onBatchSuspendUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchSuspendUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchUnsuspendUser
default CompletableFuture<BatchUnsuspendUserResponse> batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest) Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA
account. Only users onEnterpriseLWA
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.- Parameters:
batchUnsuspendUserRequest
-- Returns:
- A Java Future containing the result of the BatchUnsuspendUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchUnsuspendUser
default CompletableFuture<BatchUnsuspendUserResponse> batchUnsuspendUser(Consumer<BatchUnsuspendUserRequest.Builder> batchUnsuspendUserRequest) Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime
EnterpriseLWA
account. Only users onEnterpriseLWA
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 viaBatchUnsuspendUserRequest.builder()
- Parameters:
batchUnsuspendUserRequest
- AConsumer
that will call methods onBatchUnsuspendUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchUnsuspendUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchUpdatePhoneNumber
default CompletableFuture<BatchUpdatePhoneNumberResponse> batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest) 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.
- Parameters:
batchUpdatePhoneNumberRequest
-- Returns:
- A Java Future containing the result of the BatchUpdatePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchUpdatePhoneNumber
default CompletableFuture<BatchUpdatePhoneNumberResponse> batchUpdatePhoneNumber(Consumer<BatchUpdatePhoneNumberRequest.Builder> batchUpdatePhoneNumberRequest) 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 viaBatchUpdatePhoneNumberRequest.builder()
- Parameters:
batchUpdatePhoneNumberRequest
- AConsumer
that will call methods onBatchUpdatePhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchUpdatePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchUpdateUser
default CompletableFuture<BatchUpdateUserResponse> batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest) 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.- Parameters:
batchUpdateUserRequest
-- Returns:
- A Java Future containing the result of the BatchUpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
batchUpdateUser
default CompletableFuture<BatchUpdateUserResponse> batchUpdateUser(Consumer<BatchUpdateUserRequest.Builder> batchUpdateUserRequest) 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 viaBatchUpdateUserRequest.builder()
- Parameters:
batchUpdateUserRequest
- AConsumer
that will call methods onBatchUpdateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchUpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccount
default CompletableFuture<CreateAccountResponse> createAccount(CreateAccountRequest createAccountRequest) 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.- Parameters:
createAccountRequest
-- Returns:
- A Java Future containing the result of the CreateAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAccount
default CompletableFuture<CreateAccountResponse> createAccount(Consumer<CreateAccountRequest.Builder> createAccountRequest) 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 viaCreateAccountRequest.builder()
- Parameters:
createAccountRequest
- AConsumer
that will call methods onCreateAccountRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAppInstance
@Deprecated default CompletableFuture<CreateAppInstanceResponse> createAppInstance(CreateAppInstanceRequest createAppInstanceRequest) Deprecated.Replaced by CreateAppInstance in the Amazon Chime SDK Identity NamespaceCreates 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.
- Parameters:
createAppInstanceRequest
-- Returns:
- A Java Future containing the result of the CreateAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAppInstance
@Deprecated default CompletableFuture<CreateAppInstanceResponse> createAppInstance(Consumer<CreateAppInstanceRequest.Builder> createAppInstanceRequest) Deprecated.Replaced by CreateAppInstance in the Amazon Chime SDK Identity NamespaceCreates 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 viaCreateAppInstanceRequest.builder()
- Parameters:
createAppInstanceRequest
- AConsumer
that will call methods onCreateAppInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAppInstanceAdmin
@Deprecated default CompletableFuture<CreateAppInstanceAdminResponse> createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest) Deprecated.Replaced by CreateAppInstanceAdmin in the Amazon Chime SDK Identity NamespacePromotes an
AppInstanceUser
to anAppInstanceAdmin
. 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 theAppInstance
. -
DeleteChannelMessage
actions.
Only an
AppInstanceUser
can be promoted to anAppInstanceAdmin
role.- Parameters:
createAppInstanceAdminRequest
-- Returns:
- A Java Future containing the result of the CreateAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
createAppInstanceAdmin
@Deprecated default CompletableFuture<CreateAppInstanceAdminResponse> createAppInstanceAdmin(Consumer<CreateAppInstanceAdminRequest.Builder> createAppInstanceAdminRequest) Deprecated.Replaced by CreateAppInstanceAdmin in the Amazon Chime SDK Identity NamespacePromotes an
AppInstanceUser
to anAppInstanceAdmin
. 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 theAppInstance
. -
DeleteChannelMessage
actions.
Only an
AppInstanceUser
can be promoted to anAppInstanceAdmin
role.
This is a convenience which creates an instance of the
CreateAppInstanceAdminRequest.Builder
avoiding the need to create one manually viaCreateAppInstanceAdminRequest.builder()
- Parameters:
createAppInstanceAdminRequest
- AConsumer
that will call methods onCreateAppInstanceAdminRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
createAppInstanceUser
@Deprecated default CompletableFuture<CreateAppInstanceUserResponse> createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest) Deprecated.Replaced by CreateAppInstanceUser in the Amazon Chime SDK Identity NamespaceCreates a user under an Amazon Chime
AppInstance
. The request consists of a uniqueappInstanceUserId
andName
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.
- Parameters:
createAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the CreateAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAppInstanceUser
@Deprecated default CompletableFuture<CreateAppInstanceUserResponse> createAppInstanceUser(Consumer<CreateAppInstanceUserRequest.Builder> createAppInstanceUserRequest) Deprecated.Replaced by CreateAppInstanceUser in the Amazon Chime SDK Identity NamespaceCreates a user under an Amazon Chime
AppInstance
. The request consists of a uniqueappInstanceUserId
andName
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 viaCreateAppInstanceUserRequest.builder()
- Parameters:
createAppInstanceUserRequest
- AConsumer
that will call methods onCreateAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAttendee
@Deprecated default CompletableFuture<CreateAttendeeResponse> createAttendee(CreateAttendeeRequest createAttendeeRequest) Deprecated.Replaced by CreateAttendee in the Amazon Chime SDK Meetings NamespaceCreates 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.
- Parameters:
createAttendeeRequest
-- Returns:
- A Java Future containing the result of the CreateAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createAttendee
@Deprecated default CompletableFuture<CreateAttendeeResponse> createAttendee(Consumer<CreateAttendeeRequest.Builder> createAttendeeRequest) Deprecated.Replaced by CreateAttendee in the Amazon Chime SDK Meetings NamespaceCreates 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 viaCreateAttendeeRequest.builder()
- Parameters:
createAttendeeRequest
- AConsumer
that will call methods onCreateAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createBot
Creates a bot for an Amazon Chime Enterprise account.
- Parameters:
createBotRequest
-- Returns:
- A Java Future containing the result of the CreateBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createBot
default CompletableFuture<CreateBotResponse> createBot(Consumer<CreateBotRequest.Builder> createBotRequest) 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 viaCreateBotRequest.builder()
- Parameters:
createBotRequest
- AConsumer
that will call methods onCreateBotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createChannel
@Deprecated default CompletableFuture<CreateChannelResponse> createChannel(CreateChannelRequest createChannelRequest) Deprecated.Replaced by CreateChannel in the Amazon Chime SDK Messaging NamespaceCreates 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 theAppInstanceUserArn
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.
- Parameters:
createChannelRequest
-- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createChannel
@Deprecated default CompletableFuture<CreateChannelResponse> createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest) Deprecated.Replaced by CreateChannel in the Amazon Chime SDK Messaging NamespaceCreates 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 theAppInstanceUserArn
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 viaCreateChannelRequest.builder()
- Parameters:
createChannelRequest
- AConsumer
that will call methods onCreateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createChannelBan
@Deprecated default CompletableFuture<CreateChannelBanResponse> createChannelBan(CreateChannelBanRequest createChannelBanRequest) Deprecated.Replaced by CreateChannelBan in the Amazon Chime SDK Messaging NamespacePermanently 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 thenCreateChannelMembership
. 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 theAppInstanceUserArn
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.
- Parameters:
createChannelBanRequest
-- Returns:
- A Java Future containing the result of the CreateChannelBan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createChannelBan
@Deprecated default CompletableFuture<CreateChannelBanResponse> createChannelBan(Consumer<CreateChannelBanRequest.Builder> createChannelBanRequest) Deprecated.Replaced by CreateChannelBan in the Amazon Chime SDK Messaging NamespacePermanently 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 thenCreateChannelMembership
. 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 theAppInstanceUserArn
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 viaCreateChannelBanRequest.builder()
- Parameters:
createChannelBanRequest
- AConsumer
that will call methods onCreateChannelBanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannelBan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createChannelMembership
@Deprecated default CompletableFuture<CreateChannelMembershipResponse> createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest) Deprecated.Replaced by CreateChannelMembership in the Amazon Chime SDK Messaging NamespaceAdds 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 theAppInstanceUserArn
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.
- Parameters:
createChannelMembershipRequest
-- Returns:
- A Java Future containing the result of the CreateChannelMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
createChannelMembership
@Deprecated default CompletableFuture<CreateChannelMembershipResponse> createChannelMembership(Consumer<CreateChannelMembershipRequest.Builder> createChannelMembershipRequest) Deprecated.Replaced by CreateChannelMembership in the Amazon Chime SDK Messaging NamespaceAdds 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 theAppInstanceUserArn
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 viaCreateChannelMembershipRequest.builder()
- Parameters:
createChannelMembershipRequest
- AConsumer
that will call methods onCreateChannelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannelMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
createChannelModerator
@Deprecated default CompletableFuture<CreateChannelModeratorResponse> createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest) Deprecated.Replaced by CreateChannelModerator in the Amazon Chime SDK Messaging NamespaceCreates 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 theAppInstanceUserArn
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.
- Parameters:
createChannelModeratorRequest
-- Returns:
- A Java Future containing the result of the CreateChannelModerator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
createChannelModerator
@Deprecated default CompletableFuture<CreateChannelModeratorResponse> createChannelModerator(Consumer<CreateChannelModeratorRequest.Builder> createChannelModeratorRequest) Deprecated.Replaced by CreateChannelModerator in the Amazon Chime SDK Messaging NamespaceCreates 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 theAppInstanceUserArn
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 viaCreateChannelModeratorRequest.builder()
- Parameters:
createChannelModeratorRequest
- AConsumer
that will call methods onCreateChannelModeratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannelModerator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
createMediaCapturePipeline
@Deprecated default CompletableFuture<CreateMediaCapturePipelineResponse> createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest) Deprecated.Replaced by CreateMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespaceCreates 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.
- Parameters:
createMediaCapturePipelineRequest
-- Returns:
- A Java Future containing the result of the CreateMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createMediaCapturePipeline
@Deprecated default CompletableFuture<CreateMediaCapturePipelineResponse> createMediaCapturePipeline(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest) Deprecated.Replaced by CreateMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespaceCreates 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 viaCreateMediaCapturePipelineRequest.builder()
- Parameters:
createMediaCapturePipelineRequest
- AConsumer
that will call methods onCreateMediaCapturePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createMeeting
@Deprecated default CompletableFuture<CreateMeetingResponse> createMeeting(CreateMeetingRequest createMeetingRequest) Deprecated.Replaced by CreateMeeting in the Amazon Chime SDK Meetings NamespaceCreates 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.
- Parameters:
createMeetingRequest
-- Returns:
- A Java Future containing the result of the CreateMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createMeeting
@Deprecated default CompletableFuture<CreateMeetingResponse> createMeeting(Consumer<CreateMeetingRequest.Builder> createMeetingRequest) Deprecated.Replaced by CreateMeeting in the Amazon Chime SDK Meetings NamespaceCreates 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 viaCreateMeetingRequest.builder()
- Parameters:
createMeetingRequest
- AConsumer
that will call methods onCreateMeetingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createMeetingDialOut
default CompletableFuture<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. 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.
- Parameters:
createMeetingDialOutRequest
-- Returns:
- A Java Future containing the result of the CreateMeetingDialOut operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createMeetingDialOut
default CompletableFuture<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. 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 viaCreateMeetingDialOutRequest.builder()
- Parameters:
createMeetingDialOutRequest
- AConsumer
that will call methods onCreateMeetingDialOutRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMeetingDialOut operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createMeetingWithAttendees
@Deprecated default CompletableFuture<CreateMeetingWithAttendeesResponse> createMeetingWithAttendees(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest) Deprecated.Replaced by CreateMeetingWithAttendees in the Amazon Chime SDK Meetings NamespaceCreates 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.
- Parameters:
createMeetingWithAttendeesRequest
-- Returns:
- A Java Future containing the result of the CreateMeetingWithAttendees operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createMeetingWithAttendees
@Deprecated default CompletableFuture<CreateMeetingWithAttendeesResponse> createMeetingWithAttendees(Consumer<CreateMeetingWithAttendeesRequest.Builder> createMeetingWithAttendeesRequest) Deprecated.Replaced by CreateMeetingWithAttendees in the Amazon Chime SDK Meetings NamespaceCreates 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 viaCreateMeetingWithAttendeesRequest.builder()
- Parameters:
createMeetingWithAttendeesRequest
- AConsumer
that will call methods onCreateMeetingWithAttendeesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMeetingWithAttendees operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createPhoneNumberOrder
default CompletableFuture<CreatePhoneNumberOrderResponse> createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest) 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.
- Parameters:
createPhoneNumberOrderRequest
-- Returns:
- A Java Future containing the result of the CreatePhoneNumberOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createPhoneNumberOrder
default CompletableFuture<CreatePhoneNumberOrderResponse> createPhoneNumberOrder(Consumer<CreatePhoneNumberOrderRequest.Builder> createPhoneNumberOrderRequest) 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 viaCreatePhoneNumberOrderRequest.builder()
- Parameters:
createPhoneNumberOrderRequest
- AConsumer
that will call methods onCreatePhoneNumberOrderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePhoneNumberOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createProxySession
@Deprecated default CompletableFuture<CreateProxySessionResponse> createProxySession(CreateProxySessionRequest createProxySessionRequest) Deprecated.Replaced by CreateProxySession in the Amazon Chime SDK Voice NamespaceCreates 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.
- Parameters:
createProxySessionRequest
-- Returns:
- A Java Future containing the result of the CreateProxySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createProxySession
@Deprecated default CompletableFuture<CreateProxySessionResponse> createProxySession(Consumer<CreateProxySessionRequest.Builder> createProxySessionRequest) Deprecated.Replaced by CreateProxySession in the Amazon Chime SDK Voice NamespaceCreates 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 viaCreateProxySessionRequest.builder()
- Parameters:
createProxySessionRequest
- AConsumer
that will call methods onCreateProxySessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProxySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createRoom
Creates a chat room for the specified Amazon Chime Enterprise account.
- Parameters:
createRoomRequest
-- Returns:
- A Java Future containing the result of the CreateRoom operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createRoom
default CompletableFuture<CreateRoomResponse> createRoom(Consumer<CreateRoomRequest.Builder> createRoomRequest) 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 viaCreateRoomRequest.builder()
- Parameters:
createRoomRequest
- AConsumer
that will call methods onCreateRoomRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRoom operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createRoomMembership
default CompletableFuture<CreateRoomMembershipResponse> createRoomMembership(CreateRoomMembershipRequest createRoomMembershipRequest) 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.
- Parameters:
createRoomMembershipRequest
-- Returns:
- A Java Future containing the result of the CreateRoomMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createRoomMembership
default CompletableFuture<CreateRoomMembershipResponse> createRoomMembership(Consumer<CreateRoomMembershipRequest.Builder> createRoomMembershipRequest) 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 viaCreateRoomMembershipRequest.builder()
- Parameters:
createRoomMembershipRequest
- AConsumer
that will call methods onCreateRoomMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRoomMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSipMediaApplication
@Deprecated default CompletableFuture<CreateSipMediaApplicationResponse> createSipMediaApplication(CreateSipMediaApplicationRequest createSipMediaApplicationRequest) Deprecated.Replaced by CreateSipMediaApplication in the Amazon Chime SDK Voice NamespaceCreates 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.
- Parameters:
createSipMediaApplicationRequest
-- Returns:
- A Java Future containing the result of the CreateSipMediaApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSipMediaApplication
@Deprecated default CompletableFuture<CreateSipMediaApplicationResponse> createSipMediaApplication(Consumer<CreateSipMediaApplicationRequest.Builder> createSipMediaApplicationRequest) Deprecated.Replaced by CreateSipMediaApplication in the Amazon Chime SDK Voice NamespaceCreates 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 viaCreateSipMediaApplicationRequest.builder()
- Parameters:
createSipMediaApplicationRequest
- AConsumer
that will call methods onCreateSipMediaApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSipMediaApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSipMediaApplicationCall
@Deprecated default CompletableFuture<CreateSipMediaApplicationCallResponse> createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest createSipMediaApplicationCallRequest) Deprecated.Replaced by CreateSipMediaApplicationCall in the Amazon Chime SDK Voice NamespaceCreates 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.
- Parameters:
createSipMediaApplicationCallRequest
-- Returns:
- A Java Future containing the result of the CreateSipMediaApplicationCall operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSipMediaApplicationCall
@Deprecated default CompletableFuture<CreateSipMediaApplicationCallResponse> createSipMediaApplicationCall(Consumer<CreateSipMediaApplicationCallRequest.Builder> createSipMediaApplicationCallRequest) Deprecated.Replaced by CreateSipMediaApplicationCall in the Amazon Chime SDK Voice NamespaceCreates 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 viaCreateSipMediaApplicationCallRequest.builder()
- Parameters:
createSipMediaApplicationCallRequest
- AConsumer
that will call methods onCreateSipMediaApplicationCallRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSipMediaApplicationCall operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSipRule
@Deprecated default CompletableFuture<CreateSipRuleResponse> createSipRule(CreateSipRuleRequest createSipRuleRequest) Deprecated.Replaced by CreateSipRule in the Amazon Chime SDK Voice NamespaceCreates 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.
- Parameters:
createSipRuleRequest
-- Returns:
- A Java Future containing the result of the CreateSipRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createSipRule
@Deprecated default CompletableFuture<CreateSipRuleResponse> createSipRule(Consumer<CreateSipRuleRequest.Builder> createSipRuleRequest) Deprecated.Replaced by CreateSipRule in the Amazon Chime SDK Voice NamespaceCreates 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 viaCreateSipRuleRequest.builder()
- Parameters:
createSipRuleRequest
- AConsumer
that will call methods onCreateSipRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSipRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createUser
Creates a user under the specified Amazon Chime account.
- Parameters:
createUserRequest
-- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createUser
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest) 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 viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createVoiceConnector
@Deprecated default CompletableFuture<CreateVoiceConnectorResponse> createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest) Deprecated.Replaced by CreateVoiceConnector in the Amazon Chime SDK Voice NamespaceCreates 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 CreateVoiceConnectorRequestinvalid input: '$'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.
- Parameters:
createVoiceConnectorRequest
-- Returns:
- A Java Future containing the result of the CreateVoiceConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createVoiceConnector
@Deprecated default CompletableFuture<CreateVoiceConnectorResponse> createVoiceConnector(Consumer<CreateVoiceConnectorRequest.Builder> createVoiceConnectorRequest) Deprecated.Replaced by CreateVoiceConnector in the Amazon Chime SDK Voice NamespaceCreates 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 CreateVoiceConnectorRequestinvalid input: '$'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 viaCreateVoiceConnectorRequest.builder()
- Parameters:
createVoiceConnectorRequest
- AConsumer
that will call methods onCreateVoiceConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVoiceConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createVoiceConnectorGroup
@Deprecated default CompletableFuture<CreateVoiceConnectorGroupResponse> createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest createVoiceConnectorGroupRequest) Deprecated.Replaced by CreateVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceCreates 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.
- Parameters:
createVoiceConnectorGroupRequest
-- Returns:
- A Java Future containing the result of the CreateVoiceConnectorGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
createVoiceConnectorGroup
@Deprecated default CompletableFuture<CreateVoiceConnectorGroupResponse> createVoiceConnectorGroup(Consumer<CreateVoiceConnectorGroupRequest.Builder> createVoiceConnectorGroupRequest) Deprecated.Replaced by CreateVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceCreates 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 viaCreateVoiceConnectorGroupRequest.builder()
- Parameters:
createVoiceConnectorGroupRequest
- AConsumer
that will call methods onCreateVoiceConnectorGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVoiceConnectorGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccount
default CompletableFuture<DeleteAccountResponse> deleteAccount(DeleteAccountRequest deleteAccountRequest) 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
andEnterpriseAD
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 yourDisabled
accounts list, you must contact AWS Support.After 90 days, deleted accounts are permanently removed from your
Disabled
accounts list.- Parameters:
deleteAccountRequest
-- Returns:
- A Java Future containing the result of the DeleteAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAccount
default CompletableFuture<DeleteAccountResponse> deleteAccount(Consumer<DeleteAccountRequest.Builder> deleteAccountRequest) 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
andEnterpriseAD
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 yourDisabled
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 viaDeleteAccountRequest.builder()
- Parameters:
deleteAccountRequest
- AConsumer
that will call methods onDeleteAccountRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAppInstance
@Deprecated default CompletableFuture<DeleteAppInstanceResponse> deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest) Deprecated.Replaced by DeleteAppInstance in the Amazon Chime SDK Identity NamespaceDeletes 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.
- Parameters:
deleteAppInstanceRequest
-- Returns:
- A Java Future containing the result of the DeleteAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAppInstance
@Deprecated default CompletableFuture<DeleteAppInstanceResponse> deleteAppInstance(Consumer<DeleteAppInstanceRequest.Builder> deleteAppInstanceRequest) Deprecated.Replaced by DeleteAppInstance in the Amazon Chime SDK Identity NamespaceDeletes 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 viaDeleteAppInstanceRequest.builder()
- Parameters:
deleteAppInstanceRequest
- AConsumer
that will call methods onDeleteAppInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAppInstanceAdmin
@Deprecated default CompletableFuture<DeleteAppInstanceAdminResponse> deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest) Deprecated.Replaced by DeleteAppInstanceAdmin in the Amazon Chime SDK Identity NamespaceDemotes an
AppInstanceAdmin
to anAppInstanceUser
. 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.
- Parameters:
deleteAppInstanceAdminRequest
-- Returns:
- A Java Future containing the result of the DeleteAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAppInstanceAdmin
@Deprecated default CompletableFuture<DeleteAppInstanceAdminResponse> deleteAppInstanceAdmin(Consumer<DeleteAppInstanceAdminRequest.Builder> deleteAppInstanceAdminRequest) Deprecated.Replaced by DeleteAppInstanceAdmin in the Amazon Chime SDK Identity NamespaceDemotes an
AppInstanceAdmin
to anAppInstanceUser
. 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 viaDeleteAppInstanceAdminRequest.builder()
- Parameters:
deleteAppInstanceAdminRequest
- AConsumer
that will call methods onDeleteAppInstanceAdminRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAppInstanceStreamingConfigurations
@Deprecated default CompletableFuture<DeleteAppInstanceStreamingConfigurationsResponse> deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest deleteAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by DeleteAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespaceDeletes 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.
- Parameters:
deleteAppInstanceStreamingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DeleteAppInstanceStreamingConfigurations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAppInstanceStreamingConfigurations
@Deprecated default CompletableFuture<DeleteAppInstanceStreamingConfigurationsResponse> deleteAppInstanceStreamingConfigurations(Consumer<DeleteAppInstanceStreamingConfigurationsRequest.Builder> deleteAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by DeleteAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespaceDeletes 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 viaDeleteAppInstanceStreamingConfigurationsRequest.builder()
- Parameters:
deleteAppInstanceStreamingConfigurationsRequest
- AConsumer
that will call methods onDeleteAppInstanceStreamingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppInstanceStreamingConfigurations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAppInstanceUser
@Deprecated default CompletableFuture<DeleteAppInstanceUserResponse> deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest) Deprecated.Replaced by DeleteAppInstanceUser in the Amazon Chime SDK Identity NamespaceDeletes 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.
- Parameters:
deleteAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the DeleteAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAppInstanceUser
@Deprecated default CompletableFuture<DeleteAppInstanceUserResponse> deleteAppInstanceUser(Consumer<DeleteAppInstanceUserRequest.Builder> deleteAppInstanceUserRequest) Deprecated.Replaced by DeleteAppInstanceUser in the Amazon Chime SDK Identity NamespaceDeletes 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 viaDeleteAppInstanceUserRequest.builder()
- Parameters:
deleteAppInstanceUserRequest
- AConsumer
that will call methods onDeleteAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAttendee
@Deprecated default CompletableFuture<DeleteAttendeeResponse> deleteAttendee(DeleteAttendeeRequest deleteAttendeeRequest) Deprecated.Replaced by DeleteAttendee in the Amazon Chime SDK Meetings NamespaceDeletes 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.
- Parameters:
deleteAttendeeRequest
-- Returns:
- A Java Future containing the result of the DeleteAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteAttendee
@Deprecated default CompletableFuture<DeleteAttendeeResponse> deleteAttendee(Consumer<DeleteAttendeeRequest.Builder> deleteAttendeeRequest) Deprecated.Replaced by DeleteAttendee in the Amazon Chime SDK Meetings NamespaceDeletes 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 viaDeleteAttendeeRequest.builder()
- Parameters:
deleteAttendeeRequest
- AConsumer
that will call methods onDeleteAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannel
@Deprecated default CompletableFuture<DeleteChannelResponse> deleteChannel(DeleteChannelRequest deleteChannelRequest) Deprecated.Replaced by DeleteChannel in the Amazon Chime SDK Messaging NamespaceImmediately 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 theAppInstanceUserArn
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.
- Parameters:
deleteChannelRequest
-- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannel
@Deprecated default CompletableFuture<DeleteChannelResponse> deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Deprecated.Replaced by DeleteChannel in the Amazon Chime SDK Messaging NamespaceImmediately 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 theAppInstanceUserArn
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 viaDeleteChannelRequest.builder()
- Parameters:
deleteChannelRequest
- AConsumer
that will call methods onDeleteChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannelBan
@Deprecated default CompletableFuture<DeleteChannelBanResponse> deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest) Deprecated.Replaced by DeleteChannelBan in the Amazon Chime SDK Messaging NamespaceRemoves a user from a channel's ban list.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
deleteChannelBanRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelBan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannelBan
@Deprecated default CompletableFuture<DeleteChannelBanResponse> deleteChannelBan(Consumer<DeleteChannelBanRequest.Builder> deleteChannelBanRequest) Deprecated.Replaced by DeleteChannelBan in the Amazon Chime SDK Messaging NamespaceRemoves a user from a channel's ban list.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDeleteChannelBanRequest.builder()
- Parameters:
deleteChannelBanRequest
- AConsumer
that will call methods onDeleteChannelBanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelBan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannelMembership
@Deprecated default CompletableFuture<DeleteChannelMembershipResponse> deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest) Deprecated.Replaced by DeleteChannelMembership in the Amazon Chime SDK Messaging NamespaceRemoves a member from a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
deleteChannelMembershipRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannelMembership
@Deprecated default CompletableFuture<DeleteChannelMembershipResponse> deleteChannelMembership(Consumer<DeleteChannelMembershipRequest.Builder> deleteChannelMembershipRequest) Deprecated.Replaced by DeleteChannelMembership in the Amazon Chime SDK Messaging NamespaceRemoves a member from a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDeleteChannelMembershipRequest.builder()
- Parameters:
deleteChannelMembershipRequest
- AConsumer
that will call methods onDeleteChannelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannelMessage
@Deprecated default CompletableFuture<DeleteChannelMessageResponse> deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest) Deprecated.Replaced by DeleteChannelMessage in the Amazon Chime SDK Messaging NamespaceDeletes 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 theAppInstanceUserArn
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.
- Parameters:
deleteChannelMessageRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannelMessage
@Deprecated default CompletableFuture<DeleteChannelMessageResponse> deleteChannelMessage(Consumer<DeleteChannelMessageRequest.Builder> deleteChannelMessageRequest) Deprecated.Replaced by DeleteChannelMessage in the Amazon Chime SDK Messaging NamespaceDeletes 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 theAppInstanceUserArn
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 viaDeleteChannelMessageRequest.builder()
- Parameters:
deleteChannelMessageRequest
- AConsumer
that will call methods onDeleteChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannelModerator
@Deprecated default CompletableFuture<DeleteChannelModeratorResponse> deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest) Deprecated.Replaced by DeleteChannelModerator in the Amazon Chime SDK Messaging NamespaceDeletes a channel moderator.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
deleteChannelModeratorRequest
-- Returns:
- A Java Future containing the result of the DeleteChannelModerator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteChannelModerator
@Deprecated default CompletableFuture<DeleteChannelModeratorResponse> deleteChannelModerator(Consumer<DeleteChannelModeratorRequest.Builder> deleteChannelModeratorRequest) Deprecated.Replaced by DeleteChannelModerator in the Amazon Chime SDK Messaging NamespaceDeletes a channel moderator.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDeleteChannelModeratorRequest.builder()
- Parameters:
deleteChannelModeratorRequest
- AConsumer
that will call methods onDeleteChannelModeratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannelModerator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteEventsConfiguration
default CompletableFuture<DeleteEventsConfigurationResponse> deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest) Deletes the events configuration that allows a bot to receive outgoing events.
- Parameters:
deleteEventsConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteEventsConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteEventsConfiguration
default CompletableFuture<DeleteEventsConfigurationResponse> deleteEventsConfiguration(Consumer<DeleteEventsConfigurationRequest.Builder> deleteEventsConfigurationRequest) 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 viaDeleteEventsConfigurationRequest.builder()
- Parameters:
deleteEventsConfigurationRequest
- AConsumer
that will call methods onDeleteEventsConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEventsConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteMediaCapturePipeline
@Deprecated default CompletableFuture<DeleteMediaCapturePipelineResponse> deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest) Deprecated.Replaced by DeleteMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespaceDeletes 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.
- Parameters:
deleteMediaCapturePipelineRequest
-- Returns:
- A Java Future containing the result of the DeleteMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteMediaCapturePipeline
@Deprecated default CompletableFuture<DeleteMediaCapturePipelineResponse> deleteMediaCapturePipeline(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest) Deprecated.Replaced by DeleteMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespaceDeletes 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 viaDeleteMediaCapturePipelineRequest.builder()
- Parameters:
deleteMediaCapturePipelineRequest
- AConsumer
that will call methods onDeleteMediaCapturePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteMeeting
@Deprecated default CompletableFuture<DeleteMeetingResponse> deleteMeeting(DeleteMeetingRequest deleteMeetingRequest) Deprecated.Replaced by DeleteMeeting in the Amazon Chime SDK Meetings NamespaceDeletes 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.
- Parameters:
deleteMeetingRequest
-- Returns:
- A Java Future containing the result of the DeleteMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteMeeting
@Deprecated default CompletableFuture<DeleteMeetingResponse> deleteMeeting(Consumer<DeleteMeetingRequest.Builder> deleteMeetingRequest) Deprecated.Replaced by DeleteMeeting in the Amazon Chime SDK Meetings NamespaceDeletes 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 viaDeleteMeetingRequest.builder()
- Parameters:
deleteMeetingRequest
- AConsumer
that will call methods onDeleteMeetingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deletePhoneNumber
default CompletableFuture<DeletePhoneNumberResponse> deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest) 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.
- Parameters:
deletePhoneNumberRequest
-- Returns:
- A Java Future containing the result of the DeletePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deletePhoneNumber
default CompletableFuture<DeletePhoneNumberResponse> deletePhoneNumber(Consumer<DeletePhoneNumberRequest.Builder> deletePhoneNumberRequest) 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 viaDeletePhoneNumberRequest.builder()
- Parameters:
deletePhoneNumberRequest
- AConsumer
that will call methods onDeletePhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteProxySession
@Deprecated default CompletableFuture<DeleteProxySessionResponse> deleteProxySession(DeleteProxySessionRequest deleteProxySessionRequest) Deprecated.Replaced by DeleteProxySession in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteProxySessionRequest
-- Returns:
- A Java Future containing the result of the DeleteProxySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteProxySession
@Deprecated default CompletableFuture<DeleteProxySessionResponse> deleteProxySession(Consumer<DeleteProxySessionRequest.Builder> deleteProxySessionRequest) Deprecated.Replaced by DeleteProxySession in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteProxySessionRequest.builder()
- Parameters:
deleteProxySessionRequest
- AConsumer
that will call methods onDeleteProxySessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProxySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteRoom
Deletes a chat room in an Amazon Chime Enterprise account.
- Parameters:
deleteRoomRequest
-- Returns:
- A Java Future containing the result of the DeleteRoom operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteRoom
default CompletableFuture<DeleteRoomResponse> deleteRoom(Consumer<DeleteRoomRequest.Builder> deleteRoomRequest) 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 viaDeleteRoomRequest.builder()
- Parameters:
deleteRoomRequest
- AConsumer
that will call methods onDeleteRoomRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRoom operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteRoomMembership
default CompletableFuture<DeleteRoomMembershipResponse> deleteRoomMembership(DeleteRoomMembershipRequest deleteRoomMembershipRequest) Removes a member from a chat room in an Amazon Chime Enterprise account.
- Parameters:
deleteRoomMembershipRequest
-- Returns:
- A Java Future containing the result of the DeleteRoomMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteRoomMembership
default CompletableFuture<DeleteRoomMembershipResponse> deleteRoomMembership(Consumer<DeleteRoomMembershipRequest.Builder> deleteRoomMembershipRequest) 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 viaDeleteRoomMembershipRequest.builder()
- Parameters:
deleteRoomMembershipRequest
- AConsumer
that will call methods onDeleteRoomMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRoomMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSipMediaApplication
@Deprecated default CompletableFuture<DeleteSipMediaApplicationResponse> deleteSipMediaApplication(DeleteSipMediaApplicationRequest deleteSipMediaApplicationRequest) Deprecated.Replaced by DeleteSipMediaApplication in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteSipMediaApplicationRequest
-- Returns:
- A Java Future containing the result of the DeleteSipMediaApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSipMediaApplication
@Deprecated default CompletableFuture<DeleteSipMediaApplicationResponse> deleteSipMediaApplication(Consumer<DeleteSipMediaApplicationRequest.Builder> deleteSipMediaApplicationRequest) Deprecated.Replaced by DeleteSipMediaApplication in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteSipMediaApplicationRequest.builder()
- Parameters:
deleteSipMediaApplicationRequest
- AConsumer
that will call methods onDeleteSipMediaApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSipMediaApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSipRule
@Deprecated default CompletableFuture<DeleteSipRuleResponse> deleteSipRule(DeleteSipRuleRequest deleteSipRuleRequest) Deprecated.Replaced by DeleteSipRule in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteSipRuleRequest
-- Returns:
- A Java Future containing the result of the DeleteSipRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteSipRule
@Deprecated default CompletableFuture<DeleteSipRuleResponse> deleteSipRule(Consumer<DeleteSipRuleRequest.Builder> deleteSipRuleRequest) Deprecated.Replaced by DeleteSipRule in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteSipRuleRequest.builder()
- Parameters:
deleteSipRuleRequest
- AConsumer
that will call methods onDeleteSipRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSipRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnector
@Deprecated default CompletableFuture<DeleteVoiceConnectorResponse> deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest) Deprecated.Replaced by DeleteVoiceConnector in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteVoiceConnectorRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnector
@Deprecated default CompletableFuture<DeleteVoiceConnectorResponse> deleteVoiceConnector(Consumer<DeleteVoiceConnectorRequest.Builder> deleteVoiceConnectorRequest) Deprecated.Replaced by DeleteVoiceConnector in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteVoiceConnectorRequest.builder()
- Parameters:
deleteVoiceConnectorRequest
- AConsumer
that will call methods onDeleteVoiceConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorEmergencyCallingConfiguration
@Deprecated default CompletableFuture<DeleteVoiceConnectorEmergencyCallingConfigurationResponse> deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest deleteVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by DeleteVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteVoiceConnectorEmergencyCallingConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorEmergencyCallingConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorEmergencyCallingConfiguration
@Deprecated default CompletableFuture<DeleteVoiceConnectorEmergencyCallingConfigurationResponse> deleteVoiceConnectorEmergencyCallingConfiguration(Consumer<DeleteVoiceConnectorEmergencyCallingConfigurationRequest.Builder> deleteVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by DeleteVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteVoiceConnectorEmergencyCallingConfigurationRequest.builder()
- Parameters:
deleteVoiceConnectorEmergencyCallingConfigurationRequest
- AConsumer
that will call methods onDeleteVoiceConnectorEmergencyCallingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorEmergencyCallingConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorGroup
@Deprecated default CompletableFuture<DeleteVoiceConnectorGroupResponse> deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest deleteVoiceConnectorGroupRequest) Deprecated.Replaced by DeleteVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteVoiceConnectorGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorGroup
@Deprecated default CompletableFuture<DeleteVoiceConnectorGroupResponse> deleteVoiceConnectorGroup(Consumer<DeleteVoiceConnectorGroupRequest.Builder> deleteVoiceConnectorGroupRequest) Deprecated.Replaced by DeleteVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteVoiceConnectorGroupRequest.builder()
- Parameters:
deleteVoiceConnectorGroupRequest
- AConsumer
that will call methods onDeleteVoiceConnectorGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorOrigination
@Deprecated default CompletableFuture<DeleteVoiceConnectorOriginationResponse> deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest) Deprecated.Replaced by DeleteVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteVoiceConnectorOriginationRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorOrigination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorOrigination
@Deprecated default CompletableFuture<DeleteVoiceConnectorOriginationResponse> deleteVoiceConnectorOrigination(Consumer<DeleteVoiceConnectorOriginationRequest.Builder> deleteVoiceConnectorOriginationRequest) Deprecated.Replaced by DeleteVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteVoiceConnectorOriginationRequest.builder()
- Parameters:
deleteVoiceConnectorOriginationRequest
- AConsumer
that will call methods onDeleteVoiceConnectorOriginationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorOrigination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorProxy
@Deprecated default CompletableFuture<DeleteVoiceConnectorProxyResponse> deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest deleteVoiceConnectorProxyRequest) Deprecated.Replaced by DeleteVoiceConnectorProxy in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteVoiceConnectorProxyRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorProxy
@Deprecated default CompletableFuture<DeleteVoiceConnectorProxyResponse> deleteVoiceConnectorProxy(Consumer<DeleteVoiceConnectorProxyRequest.Builder> deleteVoiceConnectorProxyRequest) Deprecated.Replaced by DeleteVoiceConnectorProxy in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteVoiceConnectorProxyRequest.builder()
- Parameters:
deleteVoiceConnectorProxyRequest
- AConsumer
that will call methods onDeleteVoiceConnectorProxyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorStreamingConfiguration
@Deprecated default CompletableFuture<DeleteVoiceConnectorStreamingConfigurationResponse> deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest deleteVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by DeleteVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteVoiceConnectorStreamingConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorStreamingConfiguration operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorStreamingConfiguration
@Deprecated default CompletableFuture<DeleteVoiceConnectorStreamingConfigurationResponse> deleteVoiceConnectorStreamingConfiguration(Consumer<DeleteVoiceConnectorStreamingConfigurationRequest.Builder> deleteVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by DeleteVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteVoiceConnectorStreamingConfigurationRequest.builder()
- Parameters:
deleteVoiceConnectorStreamingConfigurationRequest
- AConsumer
that will call methods onDeleteVoiceConnectorStreamingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorStreamingConfiguration operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorTermination
@Deprecated default CompletableFuture<DeleteVoiceConnectorTerminationResponse> deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest) Deprecated.Replaced by DeleteVoiceConnectorTermination in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteVoiceConnectorTerminationRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorTermination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorTermination
@Deprecated default CompletableFuture<DeleteVoiceConnectorTerminationResponse> deleteVoiceConnectorTermination(Consumer<DeleteVoiceConnectorTerminationRequest.Builder> deleteVoiceConnectorTerminationRequest) Deprecated.Replaced by DeleteVoiceConnectorTermination in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteVoiceConnectorTerminationRequest.builder()
- Parameters:
deleteVoiceConnectorTerminationRequest
- AConsumer
that will call methods onDeleteVoiceConnectorTerminationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorTermination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorTerminationCredentials
@Deprecated default CompletableFuture<DeleteVoiceConnectorTerminationCredentialsResponse> deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by DeleteVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespaceDeletes 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.
- Parameters:
deleteVoiceConnectorTerminationCredentialsRequest
-- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorTerminationCredentials operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteVoiceConnectorTerminationCredentials
@Deprecated default CompletableFuture<DeleteVoiceConnectorTerminationCredentialsResponse> deleteVoiceConnectorTerminationCredentials(Consumer<DeleteVoiceConnectorTerminationCredentialsRequest.Builder> deleteVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by DeleteVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespaceDeletes 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 viaDeleteVoiceConnectorTerminationCredentialsRequest.builder()
- Parameters:
deleteVoiceConnectorTerminationCredentialsRequest
- AConsumer
that will call methods onDeleteVoiceConnectorTerminationCredentialsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVoiceConnectorTerminationCredentials operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAppInstance
@Deprecated default CompletableFuture<DescribeAppInstanceResponse> describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest) Deprecated.Replaced by DescribeAppInstance in the Amazon Chime SDK Identity NamespaceReturns 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.
- Parameters:
describeAppInstanceRequest
-- Returns:
- A Java Future containing the result of the DescribeAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAppInstance
@Deprecated default CompletableFuture<DescribeAppInstanceResponse> describeAppInstance(Consumer<DescribeAppInstanceRequest.Builder> describeAppInstanceRequest) Deprecated.Replaced by DescribeAppInstance in the Amazon Chime SDK Identity NamespaceReturns 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 viaDescribeAppInstanceRequest.builder()
- Parameters:
describeAppInstanceRequest
- AConsumer
that will call methods onDescribeAppInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAppInstanceAdmin
@Deprecated default CompletableFuture<DescribeAppInstanceAdminResponse> describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest) Deprecated.Replaced by DescribeAppInstanceAdmin in the Amazon Chime SDK Identity NamespaceReturns 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.
- Parameters:
describeAppInstanceAdminRequest
-- Returns:
- A Java Future containing the result of the DescribeAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAppInstanceAdmin
@Deprecated default CompletableFuture<DescribeAppInstanceAdminResponse> describeAppInstanceAdmin(Consumer<DescribeAppInstanceAdminRequest.Builder> describeAppInstanceAdminRequest) Deprecated.Replaced by DescribeAppInstanceAdmin in the Amazon Chime SDK Identity NamespaceReturns 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 viaDescribeAppInstanceAdminRequest.builder()
- Parameters:
describeAppInstanceAdminRequest
- AConsumer
that will call methods onDescribeAppInstanceAdminRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAppInstanceAdmin operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAppInstanceUser
@Deprecated default CompletableFuture<DescribeAppInstanceUserResponse> describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest) Deprecated.Replaced by DescribeAppInstanceUser in the Amazon Chime SDK Identity NamespaceReturns 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.
- Parameters:
describeAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the DescribeAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeAppInstanceUser
@Deprecated default CompletableFuture<DescribeAppInstanceUserResponse> describeAppInstanceUser(Consumer<DescribeAppInstanceUserRequest.Builder> describeAppInstanceUserRequest) Deprecated.Replaced by DescribeAppInstanceUser in the Amazon Chime SDK Identity NamespaceReturns 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 viaDescribeAppInstanceUserRequest.builder()
- Parameters:
describeAppInstanceUserRequest
- AConsumer
that will call methods onDescribeAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannel
@Deprecated default CompletableFuture<DescribeChannelResponse> describeChannel(DescribeChannelRequest describeChannelRequest) Deprecated.Replaced by DescribeChannel in the Amazon Chime SDK Messaging NamespaceReturns the full details of a channel in an Amazon Chime
AppInstance
.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
describeChannelRequest
-- Returns:
- A Java Future containing the result of the DescribeChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannel
@Deprecated default CompletableFuture<DescribeChannelResponse> describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) Deprecated.Replaced by DescribeChannel in the Amazon Chime SDK Messaging NamespaceReturns the full details of a channel in an Amazon Chime
AppInstance
.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDescribeChannelRequest.builder()
- Parameters:
describeChannelRequest
- AConsumer
that will call methods onDescribeChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelBan
@Deprecated default CompletableFuture<DescribeChannelBanResponse> describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest) Deprecated.Replaced by DescribeChannelBan in the Amazon Chime SDK Messaging NamespaceReturns the full details of a channel ban.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
describeChannelBanRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelBan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelBan
@Deprecated default CompletableFuture<DescribeChannelBanResponse> describeChannelBan(Consumer<DescribeChannelBanRequest.Builder> describeChannelBanRequest) Deprecated.Replaced by DescribeChannelBan in the Amazon Chime SDK Messaging NamespaceReturns the full details of a channel ban.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDescribeChannelBanRequest.builder()
- Parameters:
describeChannelBanRequest
- AConsumer
that will call methods onDescribeChannelBanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelBan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelMembership
@Deprecated default CompletableFuture<DescribeChannelMembershipResponse> describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest) Deprecated.Replaced by DescribeChannelMembership in the Amazon Chime SDK Messaging NamespaceReturns the full details of a user's channel membership.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
describeChannelMembershipRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelMembership
@Deprecated default CompletableFuture<DescribeChannelMembershipResponse> describeChannelMembership(Consumer<DescribeChannelMembershipRequest.Builder> describeChannelMembershipRequest) Deprecated.Replaced by DescribeChannelMembership in the Amazon Chime SDK Messaging NamespaceReturns the full details of a user's channel membership.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDescribeChannelMembershipRequest.builder()
- Parameters:
describeChannelMembershipRequest
- AConsumer
that will call methods onDescribeChannelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelMembershipForAppInstanceUser
@Deprecated default CompletableFuture<DescribeChannelMembershipForAppInstanceUserResponse> describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest) Deprecated.Replaced by DescribeChannelMembershipForAppInstanceUser in the Amazon Chime SDK Messaging NamespaceReturns the details of a channel based on the membership of the specified
AppInstanceUser
.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
describeChannelMembershipForAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelMembershipForAppInstanceUser operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelMembershipForAppInstanceUser
@Deprecated default CompletableFuture<DescribeChannelMembershipForAppInstanceUserResponse> describeChannelMembershipForAppInstanceUser(Consumer<DescribeChannelMembershipForAppInstanceUserRequest.Builder> describeChannelMembershipForAppInstanceUserRequest) Deprecated.Replaced by DescribeChannelMembershipForAppInstanceUser in the Amazon Chime SDK Messaging NamespaceReturns the details of a channel based on the membership of the specified
AppInstanceUser
.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDescribeChannelMembershipForAppInstanceUserRequest.builder()
- Parameters:
describeChannelMembershipForAppInstanceUserRequest
- AConsumer
that will call methods onDescribeChannelMembershipForAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelMembershipForAppInstanceUser operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelModeratedByAppInstanceUser
@Deprecated default CompletableFuture<DescribeChannelModeratedByAppInstanceUserResponse> describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest) Deprecated.Replaced by DescribeChannelModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespaceReturns the full details of a channel moderated by the specified
AppInstanceUser
.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
describeChannelModeratedByAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelModeratedByAppInstanceUser operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelModeratedByAppInstanceUser
@Deprecated default CompletableFuture<DescribeChannelModeratedByAppInstanceUserResponse> describeChannelModeratedByAppInstanceUser(Consumer<DescribeChannelModeratedByAppInstanceUserRequest.Builder> describeChannelModeratedByAppInstanceUserRequest) Deprecated.Replaced by DescribeChannelModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespaceReturns the full details of a channel moderated by the specified
AppInstanceUser
.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDescribeChannelModeratedByAppInstanceUserRequest.builder()
- Parameters:
describeChannelModeratedByAppInstanceUserRequest
- AConsumer
that will call methods onDescribeChannelModeratedByAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelModeratedByAppInstanceUser operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelModerator
@Deprecated default CompletableFuture<DescribeChannelModeratorResponse> describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest) Deprecated.Replaced by DescribeChannelModerator in the Amazon Chime SDK Messaging NamespaceReturns the full details of a single ChannelModerator.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
describeChannelModeratorRequest
-- Returns:
- A Java Future containing the result of the DescribeChannelModerator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeChannelModerator
@Deprecated default CompletableFuture<DescribeChannelModeratorResponse> describeChannelModerator(Consumer<DescribeChannelModeratorRequest.Builder> describeChannelModeratorRequest) Deprecated.Replaced by DescribeChannelModerator in the Amazon Chime SDK Messaging NamespaceReturns the full details of a single ChannelModerator.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaDescribeChannelModeratorRequest.builder()
- Parameters:
describeChannelModeratorRequest
- AConsumer
that will call methods onDescribeChannelModeratorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChannelModerator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociatePhoneNumberFromUser
default CompletableFuture<DisassociatePhoneNumberFromUserResponse> disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest) Disassociates the primary provisioned phone number from the specified Amazon Chime user.
- Parameters:
disassociatePhoneNumberFromUserRequest
-- Returns:
- A Java Future containing the result of the DisassociatePhoneNumberFromUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociatePhoneNumberFromUser
default CompletableFuture<DisassociatePhoneNumberFromUserResponse> disassociatePhoneNumberFromUser(Consumer<DisassociatePhoneNumberFromUserRequest.Builder> disassociatePhoneNumberFromUserRequest) 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 viaDisassociatePhoneNumberFromUserRequest.builder()
- Parameters:
disassociatePhoneNumberFromUserRequest
- AConsumer
that will call methods onDisassociatePhoneNumberFromUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociatePhoneNumberFromUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociatePhoneNumbersFromVoiceConnector
@Deprecated default CompletableFuture<DisassociatePhoneNumbersFromVoiceConnectorResponse> disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest) Deprecated.Replaced by DisassociatePhoneNumbersFromVoiceConnector in the Amazon Chime SDK Voice NamespaceDisassociates 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.
- Parameters:
disassociatePhoneNumbersFromVoiceConnectorRequest
-- Returns:
- A Java Future containing the result of the DisassociatePhoneNumbersFromVoiceConnector operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociatePhoneNumbersFromVoiceConnector
@Deprecated default CompletableFuture<DisassociatePhoneNumbersFromVoiceConnectorResponse> disassociatePhoneNumbersFromVoiceConnector(Consumer<DisassociatePhoneNumbersFromVoiceConnectorRequest.Builder> disassociatePhoneNumbersFromVoiceConnectorRequest) Deprecated.Replaced by DisassociatePhoneNumbersFromVoiceConnector in the Amazon Chime SDK Voice NamespaceDisassociates 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 viaDisassociatePhoneNumbersFromVoiceConnectorRequest.builder()
- Parameters:
disassociatePhoneNumbersFromVoiceConnectorRequest
- AConsumer
that will call methods onDisassociatePhoneNumbersFromVoiceConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociatePhoneNumbersFromVoiceConnector operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociatePhoneNumbersFromVoiceConnectorGroup
@Deprecated default CompletableFuture<DisassociatePhoneNumbersFromVoiceConnectorGroupResponse> disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest disassociatePhoneNumbersFromVoiceConnectorGroupRequest) Deprecated.Replaced by DisassociatePhoneNumbersFromVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceDisassociates 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.
- Parameters:
disassociatePhoneNumbersFromVoiceConnectorGroupRequest
-- Returns:
- A Java Future containing the result of the DisassociatePhoneNumbersFromVoiceConnectorGroup operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociatePhoneNumbersFromVoiceConnectorGroup
@Deprecated default CompletableFuture<DisassociatePhoneNumbersFromVoiceConnectorGroupResponse> disassociatePhoneNumbersFromVoiceConnectorGroup(Consumer<DisassociatePhoneNumbersFromVoiceConnectorGroupRequest.Builder> disassociatePhoneNumbersFromVoiceConnectorGroupRequest) Deprecated.Replaced by DisassociatePhoneNumbersFromVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceDisassociates 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 viaDisassociatePhoneNumbersFromVoiceConnectorGroupRequest.builder()
- Parameters:
disassociatePhoneNumbersFromVoiceConnectorGroupRequest
- AConsumer
that will call methods onDisassociatePhoneNumbersFromVoiceConnectorGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociatePhoneNumbersFromVoiceConnectorGroup operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociateSigninDelegateGroupsFromAccount
default CompletableFuture<DisassociateSigninDelegateGroupsFromAccountResponse> disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest) Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
- Parameters:
disassociateSigninDelegateGroupsFromAccountRequest
-- Returns:
- A Java Future containing the result of the DisassociateSigninDelegateGroupsFromAccount operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
disassociateSigninDelegateGroupsFromAccount
default CompletableFuture<DisassociateSigninDelegateGroupsFromAccountResponse> disassociateSigninDelegateGroupsFromAccount(Consumer<DisassociateSigninDelegateGroupsFromAccountRequest.Builder> disassociateSigninDelegateGroupsFromAccountRequest) 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 viaDisassociateSigninDelegateGroupsFromAccountRequest.builder()
- Parameters:
disassociateSigninDelegateGroupsFromAccountRequest
- AConsumer
that will call methods onDisassociateSigninDelegateGroupsFromAccountRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateSigninDelegateGroupsFromAccount operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccount
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
- Parameters:
getAccountRequest
-- Returns:
- A Java Future containing the result of the GetAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccount
default CompletableFuture<GetAccountResponse> getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest) 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 viaGetAccountRequest.builder()
- Parameters:
getAccountRequest
- AConsumer
that will call methods onGetAccountRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccountSettings
default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest) 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.
- Parameters:
getAccountSettingsRequest
-- Returns:
- A Java Future containing the result of the GetAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccountSettings
default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest) 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 viaGetAccountSettingsRequest.builder()
- Parameters:
getAccountSettingsRequest
- AConsumer
that will call methods onGetAccountSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAppInstanceRetentionSettings
@Deprecated default CompletableFuture<GetAppInstanceRetentionSettingsResponse> getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest) Deprecated.Replaced by GetAppInstanceRetentionSettings in the Amazon Chime SDK Identity NamespaceGets 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.
- Parameters:
getAppInstanceRetentionSettingsRequest
-- Returns:
- A Java Future containing the result of the GetAppInstanceRetentionSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAppInstanceRetentionSettings
@Deprecated default CompletableFuture<GetAppInstanceRetentionSettingsResponse> getAppInstanceRetentionSettings(Consumer<GetAppInstanceRetentionSettingsRequest.Builder> getAppInstanceRetentionSettingsRequest) Deprecated.Replaced by GetAppInstanceRetentionSettings in the Amazon Chime SDK Identity NamespaceGets 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 viaGetAppInstanceRetentionSettingsRequest.builder()
- Parameters:
getAppInstanceRetentionSettingsRequest
- AConsumer
that will call methods onGetAppInstanceRetentionSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAppInstanceRetentionSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAppInstanceStreamingConfigurations
@Deprecated default CompletableFuture<GetAppInstanceStreamingConfigurationsResponse> getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest getAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by GetAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespaceGets 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.
- Parameters:
getAppInstanceStreamingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the GetAppInstanceStreamingConfigurations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAppInstanceStreamingConfigurations
@Deprecated default CompletableFuture<GetAppInstanceStreamingConfigurationsResponse> getAppInstanceStreamingConfigurations(Consumer<GetAppInstanceStreamingConfigurationsRequest.Builder> getAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by GetAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespaceGets 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 viaGetAppInstanceStreamingConfigurationsRequest.builder()
- Parameters:
getAppInstanceStreamingConfigurationsRequest
- AConsumer
that will call methods onGetAppInstanceStreamingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAppInstanceStreamingConfigurations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAttendee
@Deprecated default CompletableFuture<GetAttendeeResponse> getAttendee(GetAttendeeRequest getAttendeeRequest) Deprecated.Replaced by GetAttendee in the Amazon Chime SDK Meetings NamespaceGets 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.
- Parameters:
getAttendeeRequest
-- Returns:
- A Java Future containing the result of the GetAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAttendee
@Deprecated default CompletableFuture<GetAttendeeResponse> getAttendee(Consumer<GetAttendeeRequest.Builder> getAttendeeRequest) Deprecated.Replaced by GetAttendee in the Amazon Chime SDK Meetings NamespaceGets 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 viaGetAttendeeRequest.builder()
- Parameters:
getAttendeeRequest
- AConsumer
that will call methods onGetAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getBot
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
- Parameters:
getBotRequest
-- Returns:
- A Java Future containing the result of the GetBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getBot
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 viaGetBotRequest.builder()
- Parameters:
getBotRequest
- AConsumer
that will call methods onGetBotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getChannelMessage
@Deprecated default CompletableFuture<GetChannelMessageResponse> getChannelMessage(GetChannelMessageRequest getChannelMessageRequest) Deprecated.Replaced by GetChannelMessage in the Amazon Chime SDK Messaging NamespaceGets 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.
- Parameters:
getChannelMessageRequest
-- Returns:
- A Java Future containing the result of the GetChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getChannelMessage
@Deprecated default CompletableFuture<GetChannelMessageResponse> getChannelMessage(Consumer<GetChannelMessageRequest.Builder> getChannelMessageRequest) Deprecated.Replaced by GetChannelMessage in the Amazon Chime SDK Messaging NamespaceGets 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 viaGetChannelMessageRequest.builder()
- Parameters:
getChannelMessageRequest
- AConsumer
that will call methods onGetChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getEventsConfiguration
default CompletableFuture<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.
- Parameters:
getEventsConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetEventsConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getEventsConfiguration
default CompletableFuture<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.
This is a convenience which creates an instance of the
GetEventsConfigurationRequest.Builder
avoiding the need to create one manually viaGetEventsConfigurationRequest.builder()
- Parameters:
getEventsConfigurationRequest
- AConsumer
that will call methods onGetEventsConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEventsConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getGlobalSettings
default CompletableFuture<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.
- Parameters:
getGlobalSettingsRequest
-- Returns:
- A Java Future containing the result of the GetGlobalSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getGlobalSettings
default CompletableFuture<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.
This is a convenience which creates an instance of the
GetGlobalSettingsRequest.Builder
avoiding the need to create one manually viaGetGlobalSettingsRequest.builder()
- Parameters:
getGlobalSettingsRequest
- AConsumer
that will call methods onGetGlobalSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGlobalSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getMediaCapturePipeline
@Deprecated default CompletableFuture<GetMediaCapturePipelineResponse> getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest) Deprecated.Replaced by GetMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespaceGets 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.
- Parameters:
getMediaCapturePipelineRequest
-- Returns:
- A Java Future containing the result of the GetMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getMediaCapturePipeline
@Deprecated default CompletableFuture<GetMediaCapturePipelineResponse> getMediaCapturePipeline(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest) Deprecated.Replaced by GetMediaCapturePipeline in the Amazon Chime SDK Media Pipelines NamespaceGets 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 viaGetMediaCapturePipelineRequest.builder()
- Parameters:
getMediaCapturePipelineRequest
- AConsumer
that will call methods onGetMediaCapturePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getMeeting
@Deprecated default CompletableFuture<GetMeetingResponse> getMeeting(GetMeetingRequest getMeetingRequest) Deprecated.Replaced by GetMeeting in the Amazon Chime SDK Meetings NamespaceThis 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 .
- Parameters:
getMeetingRequest
-- Returns:
- A Java Future containing the result of the GetMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getMeeting
@Deprecated default CompletableFuture<GetMeetingResponse> getMeeting(Consumer<GetMeetingRequest.Builder> getMeetingRequest) Deprecated.Replaced by GetMeeting in the Amazon Chime SDK Meetings NamespaceThis 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 viaGetMeetingRequest.builder()
- Parameters:
getMeetingRequest
- AConsumer
that will call methods onGetMeetingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getMessagingSessionEndpoint
@Deprecated default CompletableFuture<GetMessagingSessionEndpointResponse> getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest) Deprecated.Replaced by GetMessagingSessionEndpoint in the Amazon Chime SDK Messaging NamespaceThe 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.
- Parameters:
getMessagingSessionEndpointRequest
-- Returns:
- A Java Future containing the result of the GetMessagingSessionEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getMessagingSessionEndpoint
@Deprecated default CompletableFuture<GetMessagingSessionEndpointResponse> getMessagingSessionEndpoint(Consumer<GetMessagingSessionEndpointRequest.Builder> getMessagingSessionEndpointRequest) Deprecated.Replaced by GetMessagingSessionEndpoint in the Amazon Chime SDK Messaging NamespaceThe 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 viaGetMessagingSessionEndpointRequest.builder()
- Parameters:
getMessagingSessionEndpointRequest
- AConsumer
that will call methods onGetMessagingSessionEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMessagingSessionEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPhoneNumber
default CompletableFuture<GetPhoneNumberResponse> getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest) Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
- Parameters:
getPhoneNumberRequest
-- Returns:
- A Java Future containing the result of the GetPhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPhoneNumber
default CompletableFuture<GetPhoneNumberResponse> getPhoneNumber(Consumer<GetPhoneNumberRequest.Builder> getPhoneNumberRequest) 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 viaGetPhoneNumberRequest.builder()
- Parameters:
getPhoneNumberRequest
- AConsumer
that will call methods onGetPhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPhoneNumberOrder
default CompletableFuture<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.
- Parameters:
getPhoneNumberOrderRequest
-- Returns:
- A Java Future containing the result of the GetPhoneNumberOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPhoneNumberOrder
default CompletableFuture<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.
This is a convenience which creates an instance of the
GetPhoneNumberOrderRequest.Builder
avoiding the need to create one manually viaGetPhoneNumberOrderRequest.builder()
- Parameters:
getPhoneNumberOrderRequest
- AConsumer
that will call methods onGetPhoneNumberOrderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPhoneNumberOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPhoneNumberSettings
default CompletableFuture<GetPhoneNumberSettingsResponse> getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest) Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
- Parameters:
getPhoneNumberSettingsRequest
-- Returns:
- A Java Future containing the result of the GetPhoneNumberSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getPhoneNumberSettings
default CompletableFuture<GetPhoneNumberSettingsResponse> getPhoneNumberSettings(Consumer<GetPhoneNumberSettingsRequest.Builder> getPhoneNumberSettingsRequest) 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 viaGetPhoneNumberSettingsRequest.builder()
- Parameters:
getPhoneNumberSettingsRequest
- AConsumer
that will call methods onGetPhoneNumberSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPhoneNumberSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getProxySession
@Deprecated default CompletableFuture<GetProxySessionResponse> getProxySession(GetProxySessionRequest getProxySessionRequest) Deprecated.Replaced by GetProxySession in the Amazon Chime SDK Voice NamespaceGets 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.
- Parameters:
getProxySessionRequest
-- Returns:
- A Java Future containing the result of the GetProxySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getProxySession
@Deprecated default CompletableFuture<GetProxySessionResponse> getProxySession(Consumer<GetProxySessionRequest.Builder> getProxySessionRequest) Deprecated.Replaced by GetProxySession in the Amazon Chime SDK Voice NamespaceGets 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 viaGetProxySessionRequest.builder()
- Parameters:
getProxySessionRequest
- AConsumer
that will call methods onGetProxySessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProxySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRetentionSettings
default CompletableFuture<GetRetentionSettingsResponse> getRetentionSettings(GetRetentionSettingsRequest getRetentionSettingsRequest) 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.
- Parameters:
getRetentionSettingsRequest
-- Returns:
- A Java Future containing the result of the GetRetentionSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRetentionSettings
default CompletableFuture<GetRetentionSettingsResponse> getRetentionSettings(Consumer<GetRetentionSettingsRequest.Builder> getRetentionSettingsRequest) 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 viaGetRetentionSettingsRequest.builder()
- Parameters:
getRetentionSettingsRequest
- AConsumer
that will call methods onGetRetentionSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRetentionSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRoom
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
- Parameters:
getRoomRequest
-- Returns:
- A Java Future containing the result of the GetRoom operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getRoom
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 viaGetRoomRequest.builder()
- Parameters:
getRoomRequest
- AConsumer
that will call methods onGetRoomRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRoom operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSipMediaApplication
@Deprecated default CompletableFuture<GetSipMediaApplicationResponse> getSipMediaApplication(GetSipMediaApplicationRequest getSipMediaApplicationRequest) Deprecated.Replaced by GetSipMediaApplication in the Amazon Chime SDK Voice NamespaceRetrieves 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.
- Parameters:
getSipMediaApplicationRequest
-- Returns:
- A Java Future containing the result of the GetSipMediaApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSipMediaApplication
@Deprecated default CompletableFuture<GetSipMediaApplicationResponse> getSipMediaApplication(Consumer<GetSipMediaApplicationRequest.Builder> getSipMediaApplicationRequest) Deprecated.Replaced by GetSipMediaApplication in the Amazon Chime SDK Voice NamespaceRetrieves 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 viaGetSipMediaApplicationRequest.builder()
- Parameters:
getSipMediaApplicationRequest
- AConsumer
that will call methods onGetSipMediaApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSipMediaApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSipMediaApplicationLoggingConfiguration
@Deprecated default CompletableFuture<GetSipMediaApplicationLoggingConfigurationResponse> getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest getSipMediaApplicationLoggingConfigurationRequest) Deprecated.Replaced by GetSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice NamespaceReturns 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.
- Parameters:
getSipMediaApplicationLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetSipMediaApplicationLoggingConfiguration operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSipMediaApplicationLoggingConfiguration
@Deprecated default CompletableFuture<GetSipMediaApplicationLoggingConfigurationResponse> getSipMediaApplicationLoggingConfiguration(Consumer<GetSipMediaApplicationLoggingConfigurationRequest.Builder> getSipMediaApplicationLoggingConfigurationRequest) Deprecated.Replaced by GetSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice NamespaceReturns 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 viaGetSipMediaApplicationLoggingConfigurationRequest.builder()
- Parameters:
getSipMediaApplicationLoggingConfigurationRequest
- AConsumer
that will call methods onGetSipMediaApplicationLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSipMediaApplicationLoggingConfiguration operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSipRule
@Deprecated default CompletableFuture<GetSipRuleResponse> getSipRule(GetSipRuleRequest getSipRuleRequest) Deprecated.Replaced by GetSipRule in the Amazon Chime SDK Voice NamespaceRetrieves 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.
- Parameters:
getSipRuleRequest
-- Returns:
- A Java Future containing the result of the GetSipRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getSipRule
@Deprecated default CompletableFuture<GetSipRuleResponse> getSipRule(Consumer<GetSipRuleRequest.Builder> getSipRuleRequest) Deprecated.Replaced by GetSipRule in the Amazon Chime SDK Voice NamespaceRetrieves 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 viaGetSipRuleRequest.builder()
- Parameters:
getSipRuleRequest
- AConsumer
that will call methods onGetSipRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSipRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUser
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.
- Parameters:
getUserRequest
-- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUser
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 viaGetUserRequest.builder()
- Parameters:
getUserRequest
- AConsumer
that will call methods onGetUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUserSettings
default CompletableFuture<GetUserSettingsResponse> getUserSettings(GetUserSettingsRequest getUserSettingsRequest) Retrieves settings for the specified user ID, such as any associated phone number settings.
- Parameters:
getUserSettingsRequest
-- Returns:
- A Java Future containing the result of the GetUserSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getUserSettings
default CompletableFuture<GetUserSettingsResponse> getUserSettings(Consumer<GetUserSettingsRequest.Builder> getUserSettingsRequest) 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 viaGetUserSettingsRequest.builder()
- Parameters:
getUserSettingsRequest
- AConsumer
that will call methods onGetUserSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetUserSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnector
@Deprecated default CompletableFuture<GetVoiceConnectorResponse> getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest) Deprecated.Replaced by GetVoiceConnector in the Amazon Chime SDK Voice NamespaceRetrieves 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.
- Parameters:
getVoiceConnectorRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnector
@Deprecated default CompletableFuture<GetVoiceConnectorResponse> getVoiceConnector(Consumer<GetVoiceConnectorRequest.Builder> getVoiceConnectorRequest) Deprecated.Replaced by GetVoiceConnector in the Amazon Chime SDK Voice NamespaceRetrieves 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 viaGetVoiceConnectorRequest.builder()
- Parameters:
getVoiceConnectorRequest
- AConsumer
that will call methods onGetVoiceConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorEmergencyCallingConfiguration
@Deprecated default CompletableFuture<GetVoiceConnectorEmergencyCallingConfigurationResponse> getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest getVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespaceGets 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.
- Parameters:
getVoiceConnectorEmergencyCallingConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnectorEmergencyCallingConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorEmergencyCallingConfiguration
@Deprecated default CompletableFuture<GetVoiceConnectorEmergencyCallingConfigurationResponse> getVoiceConnectorEmergencyCallingConfiguration(Consumer<GetVoiceConnectorEmergencyCallingConfigurationRequest.Builder> getVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespaceGets 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 viaGetVoiceConnectorEmergencyCallingConfigurationRequest.builder()
- Parameters:
getVoiceConnectorEmergencyCallingConfigurationRequest
- AConsumer
that will call methods onGetVoiceConnectorEmergencyCallingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnectorEmergencyCallingConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorGroup
@Deprecated default CompletableFuture<GetVoiceConnectorGroupResponse> getVoiceConnectorGroup(GetVoiceConnectorGroupRequest getVoiceConnectorGroupRequest) Deprecated.Replaced by GetVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceRetrieves 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.
- Parameters:
getVoiceConnectorGroupRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnectorGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorGroup
@Deprecated default CompletableFuture<GetVoiceConnectorGroupResponse> getVoiceConnectorGroup(Consumer<GetVoiceConnectorGroupRequest.Builder> getVoiceConnectorGroupRequest) Deprecated.Replaced by GetVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceRetrieves 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 viaGetVoiceConnectorGroupRequest.builder()
- Parameters:
getVoiceConnectorGroupRequest
- AConsumer
that will call methods onGetVoiceConnectorGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnectorGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorLoggingConfiguration
@Deprecated default CompletableFuture<GetVoiceConnectorLoggingConfigurationResponse> getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest getVoiceConnectorLoggingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice NamespaceRetrieves 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.
- Parameters:
getVoiceConnectorLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnectorLoggingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorLoggingConfiguration
@Deprecated default CompletableFuture<GetVoiceConnectorLoggingConfigurationResponse> getVoiceConnectorLoggingConfiguration(Consumer<GetVoiceConnectorLoggingConfigurationRequest.Builder> getVoiceConnectorLoggingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice NamespaceRetrieves 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 viaGetVoiceConnectorLoggingConfigurationRequest.builder()
- Parameters:
getVoiceConnectorLoggingConfigurationRequest
- AConsumer
that will call methods onGetVoiceConnectorLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnectorLoggingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorOrigination
@Deprecated default CompletableFuture<GetVoiceConnectorOriginationResponse> getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest) Deprecated.Replaced by GetVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespaceRetrieves 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.
- Parameters:
getVoiceConnectorOriginationRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnectorOrigination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorOrigination
@Deprecated default CompletableFuture<GetVoiceConnectorOriginationResponse> getVoiceConnectorOrigination(Consumer<GetVoiceConnectorOriginationRequest.Builder> getVoiceConnectorOriginationRequest) Deprecated.Replaced by GetVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespaceRetrieves 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 viaGetVoiceConnectorOriginationRequest.builder()
- Parameters:
getVoiceConnectorOriginationRequest
- AConsumer
that will call methods onGetVoiceConnectorOriginationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnectorOrigination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorProxy
@Deprecated default CompletableFuture<GetVoiceConnectorProxyResponse> getVoiceConnectorProxy(GetVoiceConnectorProxyRequest getVoiceConnectorProxyRequest) Deprecated.Replaced by GetVoiceConnectorProxy in the Amazon Chime SDK Voice NamespaceGets 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.
- Parameters:
getVoiceConnectorProxyRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnectorProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorProxy
@Deprecated default CompletableFuture<GetVoiceConnectorProxyResponse> getVoiceConnectorProxy(Consumer<GetVoiceConnectorProxyRequest.Builder> getVoiceConnectorProxyRequest) Deprecated.Replaced by GetVoiceConnectorProxy in the Amazon Chime SDK Voice NamespaceGets 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 viaGetVoiceConnectorProxyRequest.builder()
- Parameters:
getVoiceConnectorProxyRequest
- AConsumer
that will call methods onGetVoiceConnectorProxyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnectorProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorStreamingConfiguration
@Deprecated default CompletableFuture<GetVoiceConnectorStreamingConfigurationResponse> getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest getVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespaceRetrieves 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.
- Parameters:
getVoiceConnectorStreamingConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnectorStreamingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorStreamingConfiguration
@Deprecated default CompletableFuture<GetVoiceConnectorStreamingConfigurationResponse> getVoiceConnectorStreamingConfiguration(Consumer<GetVoiceConnectorStreamingConfigurationRequest.Builder> getVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by GetVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespaceRetrieves 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 viaGetVoiceConnectorStreamingConfigurationRequest.builder()
- Parameters:
getVoiceConnectorStreamingConfigurationRequest
- AConsumer
that will call methods onGetVoiceConnectorStreamingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnectorStreamingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorTermination
@Deprecated default CompletableFuture<GetVoiceConnectorTerminationResponse> getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest) Deprecated.Replaced by GetVoiceConnectorTermination in the Amazon Chime SDK Voice NamespaceRetrieves 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.
- Parameters:
getVoiceConnectorTerminationRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnectorTermination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorTermination
@Deprecated default CompletableFuture<GetVoiceConnectorTerminationResponse> getVoiceConnectorTermination(Consumer<GetVoiceConnectorTerminationRequest.Builder> getVoiceConnectorTerminationRequest) Deprecated.Replaced by GetVoiceConnectorTermination in the Amazon Chime SDK Voice NamespaceRetrieves 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 viaGetVoiceConnectorTerminationRequest.builder()
- Parameters:
getVoiceConnectorTerminationRequest
- AConsumer
that will call methods onGetVoiceConnectorTerminationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnectorTermination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorTerminationHealth
@Deprecated default CompletableFuture<GetVoiceConnectorTerminationHealthResponse> getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest) Deprecated.Replaced by GetVoiceConnectorTerminationHealth in the Amazon Chime SDK Voice NamespaceThis 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.- Parameters:
getVoiceConnectorTerminationHealthRequest
-- Returns:
- A Java Future containing the result of the GetVoiceConnectorTerminationHealth operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getVoiceConnectorTerminationHealth
@Deprecated default CompletableFuture<GetVoiceConnectorTerminationHealthResponse> getVoiceConnectorTerminationHealth(Consumer<GetVoiceConnectorTerminationHealthRequest.Builder> getVoiceConnectorTerminationHealthRequest) Deprecated.Replaced by GetVoiceConnectorTerminationHealth in the Amazon Chime SDK Voice NamespaceThis 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 viaGetVoiceConnectorTerminationHealthRequest.builder()
- Parameters:
getVoiceConnectorTerminationHealthRequest
- AConsumer
that will call methods onGetVoiceConnectorTerminationHealthRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceConnectorTerminationHealth operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
inviteUsers
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
Team
account. OnlyTeam
account types are currently supported for this action.- Parameters:
inviteUsersRequest
-- Returns:
- A Java Future containing the result of the InviteUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
inviteUsers
default CompletableFuture<InviteUsersResponse> inviteUsers(Consumer<InviteUsersRequest.Builder> inviteUsersRequest) Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
Team
account. OnlyTeam
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 viaInviteUsersRequest.builder()
- Parameters:
inviteUsersRequest
- AConsumer
that will call methods onInviteUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the InviteUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccounts
default CompletableFuture<ListAccountsResponse> listAccounts(ListAccountsRequest listAccountsRequest) 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.
- Parameters:
listAccountsRequest
-- Returns:
- A Java Future containing the result of the ListAccounts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccounts
default CompletableFuture<ListAccountsResponse> listAccounts(Consumer<ListAccountsRequest.Builder> listAccountsRequest) 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 viaListAccountsRequest.builder()
- Parameters:
listAccountsRequest
- AConsumer
that will call methods onListAccountsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccounts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccounts
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.
- Returns:
- A Java Future containing the result of the ListAccounts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountsPaginator
This is a variant of
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAccountsResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountsPaginator
This is a variant of
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAccountsResponse response) { //... }; });
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.- Parameters:
listAccountsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAccountsPaginator
default ListAccountsPublisher listAccountsPaginator(Consumer<ListAccountsRequest.Builder> listAccountsRequest) This is a variant of
listAccounts(software.amazon.awssdk.services.chime.model.ListAccountsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAccountsPublisher publisher = client.listAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAccountsResponse response) { //... }; });
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 viaListAccountsRequest.builder()
- Parameters:
listAccountsRequest
- AConsumer
that will call methods onListAccountsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstanceAdmins
@Deprecated default CompletableFuture<ListAppInstanceAdminsResponse> listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) Deprecated.Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity NamespaceReturns 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.
- Parameters:
listAppInstanceAdminsRequest
-- Returns:
- A Java Future containing the result of the ListAppInstanceAdmins operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstanceAdmins
@Deprecated default CompletableFuture<ListAppInstanceAdminsResponse> listAppInstanceAdmins(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) Deprecated.Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity NamespaceReturns 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 viaListAppInstanceAdminsRequest.builder()
- Parameters:
listAppInstanceAdminsRequest
- AConsumer
that will call methods onListAppInstanceAdminsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAppInstanceAdmins operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstanceAdminsPaginator
@Deprecated default ListAppInstanceAdminsPublisher listAppInstanceAdminsPaginator(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest) Deprecated.Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity NamespaceThis is a variant of
listAppInstanceAdmins(software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsResponse response) { //... }; });
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.- Parameters:
listAppInstanceAdminsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstanceAdminsPaginator
@Deprecated default ListAppInstanceAdminsPublisher listAppInstanceAdminsPaginator(Consumer<ListAppInstanceAdminsRequest.Builder> listAppInstanceAdminsRequest) Deprecated.Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity NamespaceThis is a variant of
listAppInstanceAdmins(software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAppInstanceAdminsPublisher publisher = client.listAppInstanceAdminsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAppInstanceAdminsResponse response) { //... }; });
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 viaListAppInstanceAdminsRequest.builder()
- Parameters:
listAppInstanceAdminsRequest
- AConsumer
that will call methods onListAppInstanceAdminsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstanceUsers
@Deprecated default CompletableFuture<ListAppInstanceUsersResponse> listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest) Deprecated.Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity NamespaceList all
AppInstanceUsers
created under a singleAppInstance
.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.
- Parameters:
listAppInstanceUsersRequest
-- Returns:
- A Java Future containing the result of the ListAppInstanceUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstanceUsers
@Deprecated default CompletableFuture<ListAppInstanceUsersResponse> listAppInstanceUsers(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) Deprecated.Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity NamespaceList all
AppInstanceUsers
created under a singleAppInstance
.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 viaListAppInstanceUsersRequest.builder()
- Parameters:
listAppInstanceUsersRequest
- AConsumer
that will call methods onListAppInstanceUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAppInstanceUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstanceUsersPaginator
@Deprecated default ListAppInstanceUsersPublisher listAppInstanceUsersPaginator(ListAppInstanceUsersRequest listAppInstanceUsersRequest) Deprecated.Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity NamespaceThis is a variant of
listAppInstanceUsers(software.amazon.awssdk.services.chime.model.ListAppInstanceUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAppInstanceUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAppInstanceUsersResponse response) { //... }; });
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.- Parameters:
listAppInstanceUsersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstanceUsersPaginator
@Deprecated default ListAppInstanceUsersPublisher listAppInstanceUsersPaginator(Consumer<ListAppInstanceUsersRequest.Builder> listAppInstanceUsersRequest) Deprecated.Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity NamespaceThis is a variant of
listAppInstanceUsers(software.amazon.awssdk.services.chime.model.ListAppInstanceUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAppInstanceUsersPublisher publisher = client.listAppInstanceUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAppInstanceUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAppInstanceUsersResponse response) { //... }; });
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 viaListAppInstanceUsersRequest.builder()
- Parameters:
listAppInstanceUsersRequest
- AConsumer
that will call methods onListAppInstanceUsersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstances
@Deprecated default CompletableFuture<ListAppInstancesResponse> listAppInstances(ListAppInstancesRequest listAppInstancesRequest) Deprecated.Replaced by ListAppInstances in the Amazon Chime SDK Identity NamespaceLists all Amazon Chime
AppInstance
s created under a single AWS account.This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
- Parameters:
listAppInstancesRequest
-- Returns:
- A Java Future containing the result of the ListAppInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstances
@Deprecated default CompletableFuture<ListAppInstancesResponse> listAppInstances(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) Deprecated.Replaced by ListAppInstances in the Amazon Chime SDK Identity NamespaceLists all Amazon Chime
AppInstance
s created under a single AWS account.This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
This is a convenience which creates an instance of the
ListAppInstancesRequest.Builder
avoiding the need to create one manually viaListAppInstancesRequest.builder()
- Parameters:
listAppInstancesRequest
- AConsumer
that will call methods onListAppInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAppInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstancesPaginator
@Deprecated default ListAppInstancesPublisher listAppInstancesPaginator(ListAppInstancesRequest listAppInstancesRequest) Deprecated.Replaced by ListAppInstances in the Amazon Chime SDK Identity NamespaceThis is a variant of
listAppInstances(software.amazon.awssdk.services.chime.model.ListAppInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAppInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAppInstancesResponse response) { //... }; });
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.- Parameters:
listAppInstancesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAppInstancesPaginator
@Deprecated default ListAppInstancesPublisher listAppInstancesPaginator(Consumer<ListAppInstancesRequest.Builder> listAppInstancesRequest) Deprecated.Replaced by ListAppInstances in the Amazon Chime SDK Identity NamespaceThis is a variant of
listAppInstances(software.amazon.awssdk.services.chime.model.ListAppInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAppInstancesPublisher publisher = client.listAppInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAppInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAppInstancesResponse response) { //... }; });
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 viaListAppInstancesRequest.builder()
- Parameters:
listAppInstancesRequest
- AConsumer
that will call methods onListAppInstancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttendeeTags
@Deprecated default CompletableFuture<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.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.
- Parameters:
listAttendeeTagsRequest
-- Returns:
- A Java Future containing the result of the ListAttendeeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttendeeTags
@Deprecated default CompletableFuture<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.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 viaListAttendeeTagsRequest.builder()
- Parameters:
listAttendeeTagsRequest
- AConsumer
that will call methods onListAttendeeTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAttendeeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttendees
@Deprecated default CompletableFuture<ListAttendeesResponse> listAttendees(ListAttendeesRequest listAttendeesRequest) Deprecated.Replaced by ListAttendees in the Amazon Chime SDK Meetings NamespaceLists 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.
- Parameters:
listAttendeesRequest
-- Returns:
- A Java Future containing the result of the ListAttendees operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttendees
@Deprecated default CompletableFuture<ListAttendeesResponse> listAttendees(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) Deprecated.Replaced by ListAttendees in the Amazon Chime SDK Meetings NamespaceLists 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 viaListAttendeesRequest.builder()
- Parameters:
listAttendeesRequest
- AConsumer
that will call methods onListAttendeesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAttendees operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttendeesPaginator
@Deprecated default ListAttendeesPublisher listAttendeesPaginator(ListAttendeesRequest listAttendeesRequest) Deprecated.Replaced by ListAttendees in the Amazon Chime SDK Meetings NamespaceThis is a variant of
listAttendees(software.amazon.awssdk.services.chime.model.ListAttendeesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAttendeesPublisher publisher = client.listAttendeesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAttendeesPublisher publisher = client.listAttendeesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAttendeesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAttendeesResponse response) { //... }; });
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.- Parameters:
listAttendeesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listAttendeesPaginator
@Deprecated default ListAttendeesPublisher listAttendeesPaginator(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) Deprecated.Replaced by ListAttendees in the Amazon Chime SDK Meetings NamespaceThis is a variant of
listAttendees(software.amazon.awssdk.services.chime.model.ListAttendeesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListAttendeesPublisher publisher = client.listAttendeesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListAttendeesPublisher publisher = client.listAttendeesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListAttendeesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListAttendeesResponse response) { //... }; });
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 viaListAttendeesRequest.builder()
- Parameters:
listAttendeesRequest
- AConsumer
that will call methods onListAttendeesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listBots
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
- Parameters:
listBotsRequest
-- Returns:
- A Java Future containing the result of the ListBots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listBots
default CompletableFuture<ListBotsResponse> listBots(Consumer<ListBotsRequest.Builder> listBotsRequest) 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 viaListBotsRequest.builder()
- Parameters:
listBotsRequest
- AConsumer
that will call methods onListBotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listBotsPaginator
This is a variant of
listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListBotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListBotsResponse response) { //... }; });
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.- Parameters:
listBotsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listBotsPaginator
This is a variant of
listBots(software.amazon.awssdk.services.chime.model.ListBotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListBotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListBotsResponse response) { //... }; });
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 viaListBotsRequest.builder()
- Parameters:
listBotsRequest
- AConsumer
that will call methods onListBotsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelBans
@Deprecated default CompletableFuture<ListChannelBansResponse> listChannelBans(ListChannelBansRequest listChannelBansRequest) Deprecated.Replaced by ListChannelBans in the Amazon Chime SDK Messaging NamespaceLists all the users banned from a particular channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
listChannelBansRequest
-- Returns:
- A Java Future containing the result of the ListChannelBans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelBans
@Deprecated default CompletableFuture<ListChannelBansResponse> listChannelBans(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) Deprecated.Replaced by ListChannelBans in the Amazon Chime SDK Messaging NamespaceLists all the users banned from a particular channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaListChannelBansRequest.builder()
- Parameters:
listChannelBansRequest
- AConsumer
that will call methods onListChannelBansRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelBans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelBansPaginator
@Deprecated default ListChannelBansPublisher listChannelBansPaginator(ListChannelBansRequest listChannelBansRequest) Deprecated.Replaced by ListChannelBans in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelBans(software.amazon.awssdk.services.chime.model.ListChannelBansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelBansResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelBansResponse response) { //... }; });
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.- Parameters:
listChannelBansRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelBansPaginator
@Deprecated default ListChannelBansPublisher listChannelBansPaginator(Consumer<ListChannelBansRequest.Builder> listChannelBansRequest) Deprecated.Replaced by ListChannelBans in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelBans(software.amazon.awssdk.services.chime.model.ListChannelBansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelBansResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelBansResponse response) { //... }; });
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 viaListChannelBansRequest.builder()
- Parameters:
listChannelBansRequest
- AConsumer
that will call methods onListChannelBansRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMemberships
@Deprecated default CompletableFuture<ListChannelMembershipsResponse> listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest) Deprecated.Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging NamespaceLists all channel memberships in a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
listChannelMembershipsRequest
-- Returns:
- A Java Future containing the result of the ListChannelMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMemberships
@Deprecated default CompletableFuture<ListChannelMembershipsResponse> listChannelMemberships(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) Deprecated.Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging NamespaceLists all channel memberships in a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaListChannelMembershipsRequest.builder()
- Parameters:
listChannelMembershipsRequest
- AConsumer
that will call methods onListChannelMembershipsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMembershipsForAppInstanceUser
@Deprecated default CompletableFuture<ListChannelMembershipsForAppInstanceUserResponse> listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) Deprecated.Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging NamespaceLists all channels that a particular
AppInstanceUser
is a part of. Only anAppInstanceAdmin
can call the API with a user ARN that is not their own.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
listChannelMembershipsForAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the ListChannelMembershipsForAppInstanceUser operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMembershipsForAppInstanceUser
@Deprecated default CompletableFuture<ListChannelMembershipsForAppInstanceUserResponse> listChannelMembershipsForAppInstanceUser(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) Deprecated.Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging NamespaceLists all channels that a particular
AppInstanceUser
is a part of. Only anAppInstanceAdmin
can call the API with a user ARN that is not their own.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaListChannelMembershipsForAppInstanceUserRequest.builder()
- Parameters:
listChannelMembershipsForAppInstanceUserRequest
- AConsumer
that will call methods onListChannelMembershipsForAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelMembershipsForAppInstanceUser operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMembershipsForAppInstanceUserPaginator
@Deprecated default ListChannelMembershipsForAppInstanceUserPublisher listChannelMembershipsForAppInstanceUserPaginator(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest) Deprecated.Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserResponse response) { //... }; });
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.- Parameters:
listChannelMembershipsForAppInstanceUserRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMembershipsForAppInstanceUserPaginator
@Deprecated default ListChannelMembershipsForAppInstanceUserPublisher listChannelMembershipsForAppInstanceUserPaginator(Consumer<ListChannelMembershipsForAppInstanceUserRequest.Builder> listChannelMembershipsForAppInstanceUserRequest) Deprecated.Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelMembershipsForAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsForAppInstanceUserPublisher publisher = client.listChannelMembershipsForAppInstanceUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelMembershipsForAppInstanceUserResponse response) { //... }; });
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 viaListChannelMembershipsForAppInstanceUserRequest.builder()
- Parameters:
listChannelMembershipsForAppInstanceUserRequest
- AConsumer
that will call methods onListChannelMembershipsForAppInstanceUserRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMembershipsPaginator
@Deprecated default ListChannelMembershipsPublisher listChannelMembershipsPaginator(ListChannelMembershipsRequest listChannelMembershipsRequest) Deprecated.Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelMemberships(software.amazon.awssdk.services.chime.model.ListChannelMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelMembershipsResponse response) { //... }; });
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.- Parameters:
listChannelMembershipsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMembershipsPaginator
@Deprecated default ListChannelMembershipsPublisher listChannelMembershipsPaginator(Consumer<ListChannelMembershipsRequest.Builder> listChannelMembershipsRequest) Deprecated.Replaced by ListChannelMemberships in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelMemberships(software.amazon.awssdk.services.chime.model.ListChannelMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelMembershipsPublisher publisher = client.listChannelMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelMembershipsResponse response) { //... }; });
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 viaListChannelMembershipsRequest.builder()
- Parameters:
listChannelMembershipsRequest
- AConsumer
that will call methods onListChannelMembershipsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMessages
@Deprecated default CompletableFuture<ListChannelMessagesResponse> listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest) Deprecated.Replaced by ListChannelMessages in the Amazon Chime SDK Messaging NamespaceList 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.
- Parameters:
listChannelMessagesRequest
-- Returns:
- A Java Future containing the result of the ListChannelMessages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMessages
@Deprecated default CompletableFuture<ListChannelMessagesResponse> listChannelMessages(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) Deprecated.Replaced by ListChannelMessages in the Amazon Chime SDK Messaging NamespaceList 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 viaListChannelMessagesRequest.builder()
- Parameters:
listChannelMessagesRequest
- AConsumer
that will call methods onListChannelMessagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelMessages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMessagesPaginator
@Deprecated default ListChannelMessagesPublisher listChannelMessagesPaginator(ListChannelMessagesRequest listChannelMessagesRequest) Deprecated.Replaced by ListChannelMessages in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelMessages(software.amazon.awssdk.services.chime.model.ListChannelMessagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelMessagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelMessagesResponse response) { //... }; });
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.- Parameters:
listChannelMessagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelMessagesPaginator
@Deprecated default ListChannelMessagesPublisher listChannelMessagesPaginator(Consumer<ListChannelMessagesRequest.Builder> listChannelMessagesRequest) Deprecated.Replaced by ListChannelMessages in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelMessages(software.amazon.awssdk.services.chime.model.ListChannelMessagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelMessagesPublisher publisher = client.listChannelMessagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelMessagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelMessagesResponse response) { //... }; });
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 viaListChannelMessagesRequest.builder()
- Parameters:
listChannelMessagesRequest
- AConsumer
that will call methods onListChannelMessagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelModerators
@Deprecated default CompletableFuture<ListChannelModeratorsResponse> listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest) Deprecated.Replaced by ListChannelModerators in the Amazon Chime SDK Messaging NamespaceLists all the moderators for a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
listChannelModeratorsRequest
-- Returns:
- A Java Future containing the result of the ListChannelModerators operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelModerators
@Deprecated default CompletableFuture<ListChannelModeratorsResponse> listChannelModerators(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) Deprecated.Replaced by ListChannelModerators in the Amazon Chime SDK Messaging NamespaceLists all the moderators for a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaListChannelModeratorsRequest.builder()
- Parameters:
listChannelModeratorsRequest
- AConsumer
that will call methods onListChannelModeratorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelModerators operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelModeratorsPaginator
@Deprecated default ListChannelModeratorsPublisher listChannelModeratorsPaginator(ListChannelModeratorsRequest listChannelModeratorsRequest) Deprecated.Replaced by ListChannelModerators in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelModerators(software.amazon.awssdk.services.chime.model.ListChannelModeratorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelModeratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelModeratorsResponse response) { //... }; });
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.- Parameters:
listChannelModeratorsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelModeratorsPaginator
@Deprecated default ListChannelModeratorsPublisher listChannelModeratorsPaginator(Consumer<ListChannelModeratorsRequest.Builder> listChannelModeratorsRequest) Deprecated.Replaced by ListChannelModerators in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelModerators(software.amazon.awssdk.services.chime.model.ListChannelModeratorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelModeratorsPublisher publisher = client.listChannelModeratorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelModeratorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelModeratorsResponse response) { //... }; });
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 viaListChannelModeratorsRequest.builder()
- Parameters:
listChannelModeratorsRequest
- AConsumer
that will call methods onListChannelModeratorsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannels
@Deprecated default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest) Deprecated.Replaced by ListChannels in the Amazon Chime SDK Messaging NamespaceLists 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 theAppInstanceUserArn
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.
- Parameters:
listChannelsRequest
-- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
listChannels
@Deprecated default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Deprecated.Replaced by ListChannels in the Amazon Chime SDK Messaging NamespaceLists 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 theAppInstanceUserArn
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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
listChannelsModeratedByAppInstanceUser
@Deprecated default CompletableFuture<ListChannelsModeratedByAppInstanceUserResponse> listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) Deprecated.Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespaceA list of the channels moderated by an
AppInstanceUser
.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
listChannelsModeratedByAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the ListChannelsModeratedByAppInstanceUser operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelsModeratedByAppInstanceUser
@Deprecated default CompletableFuture<ListChannelsModeratedByAppInstanceUserResponse> listChannelsModeratedByAppInstanceUser(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) Deprecated.Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespaceA list of the channels moderated by an
AppInstanceUser
.The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaListChannelsModeratedByAppInstanceUserRequest.builder()
- Parameters:
listChannelsModeratedByAppInstanceUserRequest
- AConsumer
that will call methods onListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannelsModeratedByAppInstanceUser operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelsModeratedByAppInstanceUserPaginator
@Deprecated default ListChannelsModeratedByAppInstanceUserPublisher listChannelsModeratedByAppInstanceUserPaginator(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest) Deprecated.Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserResponse response) { //... }; });
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.- Parameters:
listChannelsModeratedByAppInstanceUserRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelsModeratedByAppInstanceUserPaginator
@Deprecated default ListChannelsModeratedByAppInstanceUserPublisher listChannelsModeratedByAppInstanceUserPaginator(Consumer<ListChannelsModeratedByAppInstanceUserRequest.Builder> listChannelsModeratedByAppInstanceUserRequest) Deprecated.Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannelsModeratedByAppInstanceUser(software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelsModeratedByAppInstanceUserPublisher publisher = client.listChannelsModeratedByAppInstanceUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelsModeratedByAppInstanceUserResponse response) { //... }; });
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 viaListChannelsModeratedByAppInstanceUserRequest.builder()
- Parameters:
listChannelsModeratedByAppInstanceUserRequest
- AConsumer
that will call methods onListChannelsModeratedByAppInstanceUserRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelsPaginator
@Deprecated default ListChannelsPublisher listChannelsPaginator(ListChannelsRequest listChannelsRequest) Deprecated.Replaced by ListChannels in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannels(software.amazon.awssdk.services.chime.model.ListChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelsResponse response) { //... }; });
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.- Parameters:
listChannelsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listChannelsPaginator
@Deprecated default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Deprecated.Replaced by ListChannels in the Amazon Chime SDK Messaging NamespaceThis is a variant of
listChannels(software.amazon.awssdk.services.chime.model.ListChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListChannelsResponse response) { //... }; });
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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMediaCapturePipelines
@Deprecated default CompletableFuture<ListMediaCapturePipelinesResponse> listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Deprecated.Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines NamespaceReturns 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.
- Parameters:
listMediaCapturePipelinesRequest
-- Returns:
- A Java Future containing the result of the ListMediaCapturePipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMediaCapturePipelines
@Deprecated default CompletableFuture<ListMediaCapturePipelinesResponse> listMediaCapturePipelines(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) Deprecated.Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines NamespaceReturns 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 viaListMediaCapturePipelinesRequest.builder()
- Parameters:
listMediaCapturePipelinesRequest
- AConsumer
that will call methods onListMediaCapturePipelinesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMediaCapturePipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMediaCapturePipelinesPaginator
@Deprecated default ListMediaCapturePipelinesPublisher listMediaCapturePipelinesPaginator(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Deprecated.Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines NamespaceThis is a variant of
listMediaCapturePipelines(software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesResponse response) { //... }; });
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.- Parameters:
listMediaCapturePipelinesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMediaCapturePipelinesPaginator
@Deprecated default ListMediaCapturePipelinesPublisher listMediaCapturePipelinesPaginator(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) Deprecated.Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media Pipelines NamespaceThis is a variant of
listMediaCapturePipelines(software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListMediaCapturePipelinesResponse response) { //... }; });
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 viaListMediaCapturePipelinesRequest.builder()
- Parameters:
listMediaCapturePipelinesRequest
- AConsumer
that will call methods onListMediaCapturePipelinesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMeetingTags
@Deprecated default CompletableFuture<ListMeetingTagsResponse> listMeetingTags(ListMeetingTagsRequest listMeetingTagsRequest) Deprecated.Use ListTagsForResource in the Amazon Chime SDK Meetings Namespace.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.
- Parameters:
listMeetingTagsRequest
-- Returns:
- A Java Future containing the result of the ListMeetingTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMeetingTags
@Deprecated default CompletableFuture<ListMeetingTagsResponse> listMeetingTags(Consumer<ListMeetingTagsRequest.Builder> listMeetingTagsRequest) Deprecated.Use ListTagsForResource in the Amazon Chime SDK Meetings Namespace.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 viaListMeetingTagsRequest.builder()
- Parameters:
listMeetingTagsRequest
- AConsumer
that will call methods onListMeetingTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMeetingTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMeetings
@Deprecated default CompletableFuture<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.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.
- Parameters:
listMeetingsRequest
-- Returns:
- A Java Future containing the result of the ListMeetings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMeetings
@Deprecated default CompletableFuture<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.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 viaListMeetingsRequest.builder()
- Parameters:
listMeetingsRequest
- AConsumer
that will call methods onListMeetingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMeetings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMeetingsPaginator
@Deprecated default ListMeetingsPublisher listMeetingsPaginator(ListMeetingsRequest listMeetingsRequest) Deprecated.ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.This is a variant of
listMeetings(software.amazon.awssdk.services.chime.model.ListMeetingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListMeetingsPublisher publisher = client.listMeetingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListMeetingsPublisher publisher = client.listMeetingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListMeetingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListMeetingsResponse response) { //... }; });
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.- Parameters:
listMeetingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listMeetingsPaginator
@Deprecated default ListMeetingsPublisher 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.This is a variant of
listMeetings(software.amazon.awssdk.services.chime.model.ListMeetingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListMeetingsPublisher publisher = client.listMeetingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListMeetingsPublisher publisher = client.listMeetingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListMeetingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListMeetingsResponse response) { //... }; });
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 viaListMeetingsRequest.builder()
- Parameters:
listMeetingsRequest
- AConsumer
that will call methods onListMeetingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPhoneNumberOrders
default CompletableFuture<ListPhoneNumberOrdersResponse> listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) Lists the phone number orders for the administrator's Amazon Chime account.
- Parameters:
listPhoneNumberOrdersRequest
-- Returns:
- A Java Future containing the result of the ListPhoneNumberOrders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPhoneNumberOrders
default CompletableFuture<ListPhoneNumberOrdersResponse> listPhoneNumberOrders(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) 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 viaListPhoneNumberOrdersRequest.builder()
- Parameters:
listPhoneNumberOrdersRequest
- AConsumer
that will call methods onListPhoneNumberOrdersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPhoneNumberOrders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPhoneNumberOrdersPaginator
default ListPhoneNumberOrdersPublisher listPhoneNumberOrdersPaginator(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest) This is a variant of
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersPublisher publisher = client.listPhoneNumberOrdersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersPublisher publisher = client.listPhoneNumberOrdersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse response) { //... }; });
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.- Parameters:
listPhoneNumberOrdersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPhoneNumberOrdersPaginator
default ListPhoneNumberOrdersPublisher listPhoneNumberOrdersPaginator(Consumer<ListPhoneNumberOrdersRequest.Builder> listPhoneNumberOrdersRequest) This is a variant of
listPhoneNumberOrders(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersPublisher publisher = client.listPhoneNumberOrdersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListPhoneNumberOrdersPublisher publisher = client.listPhoneNumberOrdersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListPhoneNumberOrdersResponse response) { //... }; });
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 viaListPhoneNumberOrdersRequest.builder()
- Parameters:
listPhoneNumberOrdersRequest
- AConsumer
that will call methods onListPhoneNumberOrdersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPhoneNumbers
default CompletableFuture<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.
- Parameters:
listPhoneNumbersRequest
-- Returns:
- A Java Future containing the result of the ListPhoneNumbers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPhoneNumbers
default CompletableFuture<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.
This is a convenience which creates an instance of the
ListPhoneNumbersRequest.Builder
avoiding the need to create one manually viaListPhoneNumbersRequest.builder()
- Parameters:
listPhoneNumbersRequest
- AConsumer
that will call methods onListPhoneNumbersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPhoneNumbers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPhoneNumbersPaginator
default ListPhoneNumbersPublisher listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest) This is a variant of
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse response) { //... }; });
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.- Parameters:
listPhoneNumbersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listPhoneNumbersPaginator
default ListPhoneNumbersPublisher listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest) This is a variant of
listPhoneNumbers(software.amazon.awssdk.services.chime.model.ListPhoneNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListPhoneNumbersResponse response) { //... }; });
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 viaListPhoneNumbersRequest.builder()
- Parameters:
listPhoneNumbersRequest
- AConsumer
that will call methods onListPhoneNumbersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listProxySessions
@Deprecated default CompletableFuture<ListProxySessionsResponse> listProxySessions(ListProxySessionsRequest listProxySessionsRequest) Deprecated.Replaced by ListProxySessions in the Amazon Chime SDK Voice NamespaceLists 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.
- Parameters:
listProxySessionsRequest
-- Returns:
- A Java Future containing the result of the ListProxySessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listProxySessions
@Deprecated default CompletableFuture<ListProxySessionsResponse> listProxySessions(Consumer<ListProxySessionsRequest.Builder> listProxySessionsRequest) Deprecated.Replaced by ListProxySessions in the Amazon Chime SDK Voice NamespaceLists 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 viaListProxySessionsRequest.builder()
- Parameters:
listProxySessionsRequest
- AConsumer
that will call methods onListProxySessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProxySessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listProxySessionsPaginator
@Deprecated default ListProxySessionsPublisher listProxySessionsPaginator(ListProxySessionsRequest listProxySessionsRequest) Deprecated.Replaced by ListProxySessions in the Amazon Chime SDK Voice NamespaceThis is a variant of
listProxySessions(software.amazon.awssdk.services.chime.model.ListProxySessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListProxySessionsPublisher publisher = client.listProxySessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListProxySessionsPublisher publisher = client.listProxySessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListProxySessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListProxySessionsResponse response) { //... }; });
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.- Parameters:
listProxySessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listProxySessionsPaginator
@Deprecated default ListProxySessionsPublisher listProxySessionsPaginator(Consumer<ListProxySessionsRequest.Builder> listProxySessionsRequest) Deprecated.Replaced by ListProxySessions in the Amazon Chime SDK Voice NamespaceThis is a variant of
listProxySessions(software.amazon.awssdk.services.chime.model.ListProxySessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListProxySessionsPublisher publisher = client.listProxySessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListProxySessionsPublisher publisher = client.listProxySessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListProxySessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListProxySessionsResponse response) { //... }; });
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 viaListProxySessionsRequest.builder()
- Parameters:
listProxySessionsRequest
- AConsumer
that will call methods onListProxySessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoomMemberships
default CompletableFuture<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.
- Parameters:
listRoomMembershipsRequest
-- Returns:
- A Java Future containing the result of the ListRoomMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoomMemberships
default CompletableFuture<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.
This is a convenience which creates an instance of the
ListRoomMembershipsRequest.Builder
avoiding the need to create one manually viaListRoomMembershipsRequest.builder()
- Parameters:
listRoomMembershipsRequest
- AConsumer
that will call methods onListRoomMembershipsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRoomMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoomMembershipsPaginator
default ListRoomMembershipsPublisher listRoomMembershipsPaginator(ListRoomMembershipsRequest listRoomMembershipsRequest) This is a variant of
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListRoomMembershipsPublisher publisher = client.listRoomMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsPublisher publisher = client.listRoomMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse response) { //... }; });
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.- Parameters:
listRoomMembershipsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoomMembershipsPaginator
default ListRoomMembershipsPublisher listRoomMembershipsPaginator(Consumer<ListRoomMembershipsRequest.Builder> listRoomMembershipsRequest) This is a variant of
listRoomMemberships(software.amazon.awssdk.services.chime.model.ListRoomMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListRoomMembershipsPublisher publisher = client.listRoomMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListRoomMembershipsPublisher publisher = client.listRoomMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListRoomMembershipsResponse response) { //... }; });
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 viaListRoomMembershipsRequest.builder()
- Parameters:
listRoomMembershipsRequest
- AConsumer
that will call methods onListRoomMembershipsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRooms
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.
- Parameters:
listRoomsRequest
-- Returns:
- A Java Future containing the result of the ListRooms operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRooms
default CompletableFuture<ListRoomsResponse> listRooms(Consumer<ListRoomsRequest.Builder> listRoomsRequest) 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 viaListRoomsRequest.builder()
- Parameters:
listRoomsRequest
- AConsumer
that will call methods onListRoomsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRooms operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoomsPaginator
This is a variant of
listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListRoomsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListRoomsResponse response) { //... }; });
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.- Parameters:
listRoomsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listRoomsPaginator
This is a variant of
listRooms(software.amazon.awssdk.services.chime.model.ListRoomsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListRoomsPublisher publisher = client.listRoomsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListRoomsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListRoomsResponse response) { //... }; });
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 viaListRoomsRequest.builder()
- Parameters:
listRoomsRequest
- AConsumer
that will call methods onListRoomsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSipMediaApplications
@Deprecated default CompletableFuture<ListSipMediaApplicationsResponse> listSipMediaApplications(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest) Deprecated.Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice NamespaceLists 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.
- Parameters:
listSipMediaApplicationsRequest
-- Returns:
- A Java Future containing the result of the ListSipMediaApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSipMediaApplications
@Deprecated default CompletableFuture<ListSipMediaApplicationsResponse> listSipMediaApplications(Consumer<ListSipMediaApplicationsRequest.Builder> listSipMediaApplicationsRequest) Deprecated.Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice NamespaceLists 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 viaListSipMediaApplicationsRequest.builder()
- Parameters:
listSipMediaApplicationsRequest
- AConsumer
that will call methods onListSipMediaApplicationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSipMediaApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSipMediaApplicationsPaginator
@Deprecated default ListSipMediaApplicationsPublisher listSipMediaApplicationsPaginator(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest) Deprecated.Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice NamespaceThis is a variant of
listSipMediaApplications(software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsPublisher publisher = client.listSipMediaApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsPublisher publisher = client.listSipMediaApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsResponse response) { //... }; });
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.- Parameters:
listSipMediaApplicationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSipMediaApplicationsPaginator
@Deprecated default ListSipMediaApplicationsPublisher listSipMediaApplicationsPaginator(Consumer<ListSipMediaApplicationsRequest.Builder> listSipMediaApplicationsRequest) Deprecated.Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice NamespaceThis is a variant of
listSipMediaApplications(software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsPublisher publisher = client.listSipMediaApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListSipMediaApplicationsPublisher publisher = client.listSipMediaApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListSipMediaApplicationsResponse response) { //... }; });
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 viaListSipMediaApplicationsRequest.builder()
- Parameters:
listSipMediaApplicationsRequest
- AConsumer
that will call methods onListSipMediaApplicationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSipRules
@Deprecated default CompletableFuture<ListSipRulesResponse> listSipRules(ListSipRulesRequest listSipRulesRequest) Deprecated.Replaced by ListSipRules in the Amazon Chime SDK Voice NamespaceLists 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.
- Parameters:
listSipRulesRequest
-- Returns:
- A Java Future containing the result of the ListSipRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSipRules
@Deprecated default CompletableFuture<ListSipRulesResponse> listSipRules(Consumer<ListSipRulesRequest.Builder> listSipRulesRequest) Deprecated.Replaced by ListSipRules in the Amazon Chime SDK Voice NamespaceLists 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 viaListSipRulesRequest.builder()
- Parameters:
listSipRulesRequest
- AConsumer
that will call methods onListSipRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSipRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSipRulesPaginator
@Deprecated default ListSipRulesPublisher listSipRulesPaginator(ListSipRulesRequest listSipRulesRequest) Deprecated.Replaced by ListSipRules in the Amazon Chime SDK Voice NamespaceThis is a variant of
listSipRules(software.amazon.awssdk.services.chime.model.ListSipRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListSipRulesPublisher publisher = client.listSipRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListSipRulesPublisher publisher = client.listSipRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListSipRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListSipRulesResponse response) { //... }; });
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.- Parameters:
listSipRulesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSipRulesPaginator
@Deprecated default ListSipRulesPublisher listSipRulesPaginator(Consumer<ListSipRulesRequest.Builder> listSipRulesRequest) Deprecated.Replaced by ListSipRules in the Amazon Chime SDK Voice NamespaceThis is a variant of
listSipRules(software.amazon.awssdk.services.chime.model.ListSipRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListSipRulesPublisher publisher = client.listSipRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListSipRulesPublisher publisher = client.listSipRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListSipRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListSipRulesResponse response) { //... }; });
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 viaListSipRulesRequest.builder()
- Parameters:
listSipRulesRequest
- AConsumer
that will call methods onListSipRulesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSupportedPhoneNumberCountries
default CompletableFuture<ListSupportedPhoneNumberCountriesResponse> listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest) Lists supported phone number countries.
- Parameters:
listSupportedPhoneNumberCountriesRequest
-- Returns:
- A Java Future containing the result of the ListSupportedPhoneNumberCountries operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listSupportedPhoneNumberCountries
default CompletableFuture<ListSupportedPhoneNumberCountriesResponse> listSupportedPhoneNumberCountries(Consumer<ListSupportedPhoneNumberCountriesRequest.Builder> listSupportedPhoneNumberCountriesRequest) Lists supported phone number countries.
This is a convenience which creates an instance of the
ListSupportedPhoneNumberCountriesRequest.Builder
avoiding the need to create one manually viaListSupportedPhoneNumberCountriesRequest.builder()
- Parameters:
listSupportedPhoneNumberCountriesRequest
- AConsumer
that will call methods onListSupportedPhoneNumberCountriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSupportedPhoneNumberCountries operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTagsForResource
@Deprecated default CompletableFuture<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 NamespacesLists 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.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
listTagsForResource
@Deprecated default CompletableFuture<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 NamespacesLists 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
listUsers
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.
- Parameters:
listUsersRequest
-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) 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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListUsersResponse response) { //... }; });
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.- Parameters:
listUsersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.chime.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListUsersResponse response) { //... }; });
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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectorGroups
@Deprecated default CompletableFuture<ListVoiceConnectorGroupsResponse> listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest) Deprecated.Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice NamespaceLists 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.
- Parameters:
listVoiceConnectorGroupsRequest
-- Returns:
- A Java Future containing the result of the ListVoiceConnectorGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectorGroups
@Deprecated default CompletableFuture<ListVoiceConnectorGroupsResponse> listVoiceConnectorGroups(Consumer<ListVoiceConnectorGroupsRequest.Builder> listVoiceConnectorGroupsRequest) Deprecated.Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice NamespaceLists 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 viaListVoiceConnectorGroupsRequest.builder()
- Parameters:
listVoiceConnectorGroupsRequest
- AConsumer
that will call methods onListVoiceConnectorGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVoiceConnectorGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectorGroupsPaginator
@Deprecated default ListVoiceConnectorGroupsPublisher listVoiceConnectorGroupsPaginator(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest) Deprecated.Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice NamespaceThis is a variant of
listVoiceConnectorGroups(software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsPublisher publisher = client.listVoiceConnectorGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsPublisher publisher = client.listVoiceConnectorGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsResponse response) { //... }; });
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.- Parameters:
listVoiceConnectorGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectorGroupsPaginator
@Deprecated default ListVoiceConnectorGroupsPublisher listVoiceConnectorGroupsPaginator(Consumer<ListVoiceConnectorGroupsRequest.Builder> listVoiceConnectorGroupsRequest) Deprecated.Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice NamespaceThis is a variant of
listVoiceConnectorGroups(software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsPublisher publisher = client.listVoiceConnectorGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorGroupsPublisher publisher = client.listVoiceConnectorGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListVoiceConnectorGroupsResponse response) { //... }; });
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 viaListVoiceConnectorGroupsRequest.builder()
- Parameters:
listVoiceConnectorGroupsRequest
- AConsumer
that will call methods onListVoiceConnectorGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectorTerminationCredentials
@Deprecated default CompletableFuture<ListVoiceConnectorTerminationCredentialsResponse> listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by ListVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespaceLists 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.
- Parameters:
listVoiceConnectorTerminationCredentialsRequest
-- Returns:
- A Java Future containing the result of the ListVoiceConnectorTerminationCredentials operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectorTerminationCredentials
@Deprecated default CompletableFuture<ListVoiceConnectorTerminationCredentialsResponse> listVoiceConnectorTerminationCredentials(Consumer<ListVoiceConnectorTerminationCredentialsRequest.Builder> listVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by ListVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespaceLists 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 viaListVoiceConnectorTerminationCredentialsRequest.builder()
- Parameters:
listVoiceConnectorTerminationCredentialsRequest
- AConsumer
that will call methods onListVoiceConnectorTerminationCredentialsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVoiceConnectorTerminationCredentials operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectors
@Deprecated default CompletableFuture<ListVoiceConnectorsResponse> listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest) Deprecated.Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice NamespaceLists 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.
- Parameters:
listVoiceConnectorsRequest
-- Returns:
- A Java Future containing the result of the ListVoiceConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectors
@Deprecated default CompletableFuture<ListVoiceConnectorsResponse> listVoiceConnectors(Consumer<ListVoiceConnectorsRequest.Builder> listVoiceConnectorsRequest) Deprecated.Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice NamespaceLists 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 viaListVoiceConnectorsRequest.builder()
- Parameters:
listVoiceConnectorsRequest
- AConsumer
that will call methods onListVoiceConnectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVoiceConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectorsPaginator
@Deprecated default ListVoiceConnectorsPublisher listVoiceConnectorsPaginator(ListVoiceConnectorsRequest listVoiceConnectorsRequest) Deprecated.Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice NamespaceThis is a variant of
listVoiceConnectors(software.amazon.awssdk.services.chime.model.ListVoiceConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsPublisher publisher = client.listVoiceConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsPublisher publisher = client.listVoiceConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListVoiceConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListVoiceConnectorsResponse response) { //... }; });
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.- Parameters:
listVoiceConnectorsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listVoiceConnectorsPaginator
@Deprecated default ListVoiceConnectorsPublisher listVoiceConnectorsPaginator(Consumer<ListVoiceConnectorsRequest.Builder> listVoiceConnectorsRequest) Deprecated.Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice NamespaceThis is a variant of
listVoiceConnectors(software.amazon.awssdk.services.chime.model.ListVoiceConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsPublisher publisher = client.listVoiceConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.ListVoiceConnectorsPublisher publisher = client.listVoiceConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.ListVoiceConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.ListVoiceConnectorsResponse response) { //... }; });
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 viaListVoiceConnectorsRequest.builder()
- Parameters:
listVoiceConnectorsRequest
- AConsumer
that will call methods onListVoiceConnectorsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
logoutUser
Logs out the specified user from all of the devices they are currently logged into.
- Parameters:
logoutUserRequest
-- Returns:
- A Java Future containing the result of the LogoutUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
logoutUser
default CompletableFuture<LogoutUserResponse> logoutUser(Consumer<LogoutUserRequest.Builder> logoutUserRequest) 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 viaLogoutUserRequest.builder()
- Parameters:
logoutUserRequest
- AConsumer
that will call methods onLogoutUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the LogoutUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putAppInstanceRetentionSettings
@Deprecated default CompletableFuture<PutAppInstanceRetentionSettingsResponse> putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest) Deprecated.Replaced by PutAppInstanceRetentionSettings in the Amazon Chime SDK Identity NamespaceSets 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.
- Parameters:
putAppInstanceRetentionSettingsRequest
-- Returns:
- A Java Future containing the result of the PutAppInstanceRetentionSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putAppInstanceRetentionSettings
@Deprecated default CompletableFuture<PutAppInstanceRetentionSettingsResponse> putAppInstanceRetentionSettings(Consumer<PutAppInstanceRetentionSettingsRequest.Builder> putAppInstanceRetentionSettingsRequest) Deprecated.Replaced by PutAppInstanceRetentionSettings in the Amazon Chime SDK Identity NamespaceSets 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 viaPutAppInstanceRetentionSettingsRequest.builder()
- Parameters:
putAppInstanceRetentionSettingsRequest
- AConsumer
that will call methods onPutAppInstanceRetentionSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAppInstanceRetentionSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putAppInstanceStreamingConfigurations
@Deprecated default CompletableFuture<PutAppInstanceStreamingConfigurationsResponse> putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest putAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by PutAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespaceThe 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.
- Parameters:
putAppInstanceStreamingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the PutAppInstanceStreamingConfigurations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putAppInstanceStreamingConfigurations
@Deprecated default CompletableFuture<PutAppInstanceStreamingConfigurationsResponse> putAppInstanceStreamingConfigurations(Consumer<PutAppInstanceStreamingConfigurationsRequest.Builder> putAppInstanceStreamingConfigurationsRequest) Deprecated.Replaced by PutAppInstanceStreamingConfigurations in the Amazon Chime SDK Messaging NamespaceThe 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 viaPutAppInstanceStreamingConfigurationsRequest.builder()
- Parameters:
putAppInstanceStreamingConfigurationsRequest
- AConsumer
that will call methods onPutAppInstanceStreamingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAppInstanceStreamingConfigurations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putEventsConfiguration
default CompletableFuture<PutEventsConfigurationResponse> putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest) 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.
- Parameters:
putEventsConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutEventsConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putEventsConfiguration
default CompletableFuture<PutEventsConfigurationResponse> putEventsConfiguration(Consumer<PutEventsConfigurationRequest.Builder> putEventsConfigurationRequest) 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 viaPutEventsConfigurationRequest.builder()
- Parameters:
putEventsConfigurationRequest
- AConsumer
that will call methods onPutEventsConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutEventsConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putRetentionSettings
default CompletableFuture<PutRetentionSettingsResponse> putRetentionSettings(PutRetentionSettingsRequest putRetentionSettingsRequest) 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.
- Parameters:
putRetentionSettingsRequest
-- Returns:
- A Java Future containing the result of the PutRetentionSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putRetentionSettings
default CompletableFuture<PutRetentionSettingsResponse> putRetentionSettings(Consumer<PutRetentionSettingsRequest.Builder> putRetentionSettingsRequest) 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 viaPutRetentionSettingsRequest.builder()
- Parameters:
putRetentionSettingsRequest
- AConsumer
that will call methods onPutRetentionSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRetentionSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putSipMediaApplicationLoggingConfiguration
@Deprecated default CompletableFuture<PutSipMediaApplicationLoggingConfigurationResponse> putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest putSipMediaApplicationLoggingConfigurationRequest) Deprecated.Replaced by PutSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice NamespaceUpdates 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.
- Parameters:
putSipMediaApplicationLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutSipMediaApplicationLoggingConfiguration operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putSipMediaApplicationLoggingConfiguration
@Deprecated default CompletableFuture<PutSipMediaApplicationLoggingConfigurationResponse> putSipMediaApplicationLoggingConfiguration(Consumer<PutSipMediaApplicationLoggingConfigurationRequest.Builder> putSipMediaApplicationLoggingConfigurationRequest) Deprecated.Replaced by PutSipMediaApplicationLoggingConfiguration in the Amazon Chime SDK Voice NamespaceUpdates 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 viaPutSipMediaApplicationLoggingConfigurationRequest.builder()
- Parameters:
putSipMediaApplicationLoggingConfigurationRequest
- AConsumer
that will call methods onPutSipMediaApplicationLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutSipMediaApplicationLoggingConfiguration operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorEmergencyCallingConfiguration
@Deprecated default CompletableFuture<PutVoiceConnectorEmergencyCallingConfigurationResponse> putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest putVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespacePuts 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.
- Parameters:
putVoiceConnectorEmergencyCallingConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutVoiceConnectorEmergencyCallingConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorEmergencyCallingConfiguration
@Deprecated default CompletableFuture<PutVoiceConnectorEmergencyCallingConfigurationResponse> putVoiceConnectorEmergencyCallingConfiguration(Consumer<PutVoiceConnectorEmergencyCallingConfigurationRequest.Builder> putVoiceConnectorEmergencyCallingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorEmergencyCallingConfiguration in the Amazon Chime SDK Voice NamespacePuts 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 viaPutVoiceConnectorEmergencyCallingConfigurationRequest.builder()
- Parameters:
putVoiceConnectorEmergencyCallingConfigurationRequest
- AConsumer
that will call methods onPutVoiceConnectorEmergencyCallingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutVoiceConnectorEmergencyCallingConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorLoggingConfiguration
@Deprecated default CompletableFuture<PutVoiceConnectorLoggingConfigurationResponse> putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest putVoiceConnectorLoggingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice NamespaceAdds 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.
- Parameters:
putVoiceConnectorLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutVoiceConnectorLoggingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorLoggingConfiguration
@Deprecated default CompletableFuture<PutVoiceConnectorLoggingConfigurationResponse> putVoiceConnectorLoggingConfiguration(Consumer<PutVoiceConnectorLoggingConfigurationRequest.Builder> putVoiceConnectorLoggingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorLoggingConfiguration in the Amazon Chime SDK Voice NamespaceAdds 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 viaPutVoiceConnectorLoggingConfigurationRequest.builder()
- Parameters:
putVoiceConnectorLoggingConfigurationRequest
- AConsumer
that will call methods onPutVoiceConnectorLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutVoiceConnectorLoggingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorOrigination
@Deprecated default CompletableFuture<PutVoiceConnectorOriginationResponse> putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest) Deprecated.Replaced by PutVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespaceAdds 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.
- Parameters:
putVoiceConnectorOriginationRequest
-- Returns:
- A Java Future containing the result of the PutVoiceConnectorOrigination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorOrigination
@Deprecated default CompletableFuture<PutVoiceConnectorOriginationResponse> putVoiceConnectorOrigination(Consumer<PutVoiceConnectorOriginationRequest.Builder> putVoiceConnectorOriginationRequest) Deprecated.Replaced by PutVoiceConnectorOrigination in the Amazon Chime SDK Voice NamespaceAdds 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 viaPutVoiceConnectorOriginationRequest.builder()
- Parameters:
putVoiceConnectorOriginationRequest
- AConsumer
that will call methods onPutVoiceConnectorOriginationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutVoiceConnectorOrigination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorProxy
@Deprecated default CompletableFuture<PutVoiceConnectorProxyResponse> putVoiceConnectorProxy(PutVoiceConnectorProxyRequest putVoiceConnectorProxyRequest) Deprecated.Replaced by PutVoiceConnectorProxy in the Amazon Chime SDK Voice NamespacePuts 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.
- Parameters:
putVoiceConnectorProxyRequest
-- Returns:
- A Java Future containing the result of the PutVoiceConnectorProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorProxy
@Deprecated default CompletableFuture<PutVoiceConnectorProxyResponse> putVoiceConnectorProxy(Consumer<PutVoiceConnectorProxyRequest.Builder> putVoiceConnectorProxyRequest) Deprecated.Replaced by PutVoiceConnectorProxy in the Amazon Chime SDK Voice NamespacePuts 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 viaPutVoiceConnectorProxyRequest.builder()
- Parameters:
putVoiceConnectorProxyRequest
- AConsumer
that will call methods onPutVoiceConnectorProxyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutVoiceConnectorProxy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorStreamingConfiguration
@Deprecated default CompletableFuture<PutVoiceConnectorStreamingConfigurationResponse> putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest putVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespaceAdds 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.
- Parameters:
putVoiceConnectorStreamingConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutVoiceConnectorStreamingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorStreamingConfiguration
@Deprecated default CompletableFuture<PutVoiceConnectorStreamingConfigurationResponse> putVoiceConnectorStreamingConfiguration(Consumer<PutVoiceConnectorStreamingConfigurationRequest.Builder> putVoiceConnectorStreamingConfigurationRequest) Deprecated.Replaced by PutVoiceConnectorStreamingConfiguration in the Amazon Chime SDK Voice NamespaceAdds 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 viaPutVoiceConnectorStreamingConfigurationRequest.builder()
- Parameters:
putVoiceConnectorStreamingConfigurationRequest
- AConsumer
that will call methods onPutVoiceConnectorStreamingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutVoiceConnectorStreamingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorTermination
@Deprecated default CompletableFuture<PutVoiceConnectorTerminationResponse> putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest) Deprecated.Replaced by PutVoiceConnectorTermination in the Amazon Chime SDK Voice NamespaceAdds 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.
- Parameters:
putVoiceConnectorTerminationRequest
-- Returns:
- A Java Future containing the result of the PutVoiceConnectorTermination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorTermination
@Deprecated default CompletableFuture<PutVoiceConnectorTerminationResponse> putVoiceConnectorTermination(Consumer<PutVoiceConnectorTerminationRequest.Builder> putVoiceConnectorTerminationRequest) Deprecated.Replaced by PutVoiceConnectorTermination in the Amazon Chime SDK Voice NamespaceAdds 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 viaPutVoiceConnectorTerminationRequest.builder()
- Parameters:
putVoiceConnectorTerminationRequest
- AConsumer
that will call methods onPutVoiceConnectorTerminationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutVoiceConnectorTermination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorTerminationCredentials
@Deprecated default CompletableFuture<PutVoiceConnectorTerminationCredentialsResponse> putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by PutVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespaceAdds 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.
- Parameters:
putVoiceConnectorTerminationCredentialsRequest
-- Returns:
- A Java Future containing the result of the PutVoiceConnectorTerminationCredentials operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putVoiceConnectorTerminationCredentials
@Deprecated default CompletableFuture<PutVoiceConnectorTerminationCredentialsResponse> putVoiceConnectorTerminationCredentials(Consumer<PutVoiceConnectorTerminationCredentialsRequest.Builder> putVoiceConnectorTerminationCredentialsRequest) Deprecated.Replaced by PutVoiceConnectorTerminationCredentials in the Amazon Chime SDK Voice NamespaceAdds 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 viaPutVoiceConnectorTerminationCredentialsRequest.builder()
- Parameters:
putVoiceConnectorTerminationCredentialsRequest
- AConsumer
that will call methods onPutVoiceConnectorTerminationCredentialsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutVoiceConnectorTerminationCredentials operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
redactChannelMessage
@Deprecated default CompletableFuture<RedactChannelMessageResponse> redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest) Deprecated.Replaced by RedactChannelMessage in the Amazon Chime SDK Messaging NamespaceRedacts 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 theAppInstanceUserArn
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.
- Parameters:
redactChannelMessageRequest
-- Returns:
- A Java Future containing the result of the RedactChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
redactChannelMessage
@Deprecated default CompletableFuture<RedactChannelMessageResponse> redactChannelMessage(Consumer<RedactChannelMessageRequest.Builder> redactChannelMessageRequest) Deprecated.Replaced by RedactChannelMessage in the Amazon Chime SDK Messaging NamespaceRedacts 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 theAppInstanceUserArn
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 viaRedactChannelMessageRequest.builder()
- Parameters:
redactChannelMessageRequest
- AConsumer
that will call methods onRedactChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RedactChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
redactConversationMessage
default CompletableFuture<RedactConversationMessageResponse> redactConversationMessage(RedactConversationMessageRequest redactConversationMessageRequest) Redacts the specified message from the specified Amazon Chime conversation.
- Parameters:
redactConversationMessageRequest
-- Returns:
- A Java Future containing the result of the RedactConversationMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
redactConversationMessage
default CompletableFuture<RedactConversationMessageResponse> redactConversationMessage(Consumer<RedactConversationMessageRequest.Builder> redactConversationMessageRequest) 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 viaRedactConversationMessageRequest.builder()
- Parameters:
redactConversationMessageRequest
- AConsumer
that will call methods onRedactConversationMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RedactConversationMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
redactRoomMessage
default CompletableFuture<RedactRoomMessageResponse> redactRoomMessage(RedactRoomMessageRequest redactRoomMessageRequest) Redacts the specified message from the specified Amazon Chime channel.
- Parameters:
redactRoomMessageRequest
-- Returns:
- A Java Future containing the result of the RedactRoomMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
redactRoomMessage
default CompletableFuture<RedactRoomMessageResponse> redactRoomMessage(Consumer<RedactRoomMessageRequest.Builder> redactRoomMessageRequest) 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 viaRedactRoomMessageRequest.builder()
- Parameters:
redactRoomMessageRequest
- AConsumer
that will call methods onRedactRoomMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RedactRoomMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
regenerateSecurityToken
default CompletableFuture<RegenerateSecurityTokenResponse> regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest) Regenerates the security token for a bot.
- Parameters:
regenerateSecurityTokenRequest
-- Returns:
- A Java Future containing the result of the RegenerateSecurityToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
regenerateSecurityToken
default CompletableFuture<RegenerateSecurityTokenResponse> regenerateSecurityToken(Consumer<RegenerateSecurityTokenRequest.Builder> regenerateSecurityTokenRequest) 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 viaRegenerateSecurityTokenRequest.builder()
- Parameters:
regenerateSecurityTokenRequest
- AConsumer
that will call methods onRegenerateSecurityTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegenerateSecurityToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resetPersonalPIN
default CompletableFuture<ResetPersonalPinResponse> resetPersonalPIN(ResetPersonalPinRequest resetPersonalPinRequest) Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
- Parameters:
resetPersonalPinRequest
-- Returns:
- A Java Future containing the result of the ResetPersonalPIN operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resetPersonalPIN
default CompletableFuture<ResetPersonalPinResponse> resetPersonalPIN(Consumer<ResetPersonalPinRequest.Builder> resetPersonalPinRequest) 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 viaResetPersonalPinRequest.builder()
- Parameters:
resetPersonalPinRequest
- AConsumer
that will call methods onResetPersonalPinRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetPersonalPIN operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
restorePhoneNumber
default CompletableFuture<RestorePhoneNumberResponse> restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest) Moves a phone number from the Deletion queue back into the phone number Inventory.
- Parameters:
restorePhoneNumberRequest
-- Returns:
- A Java Future containing the result of the RestorePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
restorePhoneNumber
default CompletableFuture<RestorePhoneNumberResponse> restorePhoneNumber(Consumer<RestorePhoneNumberRequest.Builder> restorePhoneNumberRequest) 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 viaRestorePhoneNumberRequest.builder()
- Parameters:
restorePhoneNumberRequest
- AConsumer
that will call methods onRestorePhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestorePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
searchAvailablePhoneNumbers
default CompletableFuture<SearchAvailablePhoneNumbersResponse> searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters:
AreaCode
,City
,State
, orTollFreePrefix
. If you provideCity
, you must also provideState
. Numbers outside the US only support thePhoneNumberType
filter, which you must use.- Parameters:
searchAvailablePhoneNumbersRequest
-- Returns:
- A Java Future containing the result of the SearchAvailablePhoneNumbers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
searchAvailablePhoneNumbers
default CompletableFuture<SearchAvailablePhoneNumbersResponse> searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters:
AreaCode
,City
,State
, orTollFreePrefix
. If you provideCity
, you must also provideState
. Numbers outside the US only support thePhoneNumberType
filter, which you must use.
This is a convenience which creates an instance of the
SearchAvailablePhoneNumbersRequest.Builder
avoiding the need to create one manually viaSearchAvailablePhoneNumbersRequest.builder()
- Parameters:
searchAvailablePhoneNumbersRequest
- AConsumer
that will call methods onSearchAvailablePhoneNumbersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchAvailablePhoneNumbers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
searchAvailablePhoneNumbersPaginator
default SearchAvailablePhoneNumbersPublisher searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest) This is a variant of
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse response) { //... }; });
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.- Parameters:
searchAvailablePhoneNumbersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
searchAvailablePhoneNumbersPaginator
default SearchAvailablePhoneNumbersPublisher searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest) This is a variant of
searchAvailablePhoneNumbers(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chime.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chime.model.SearchAvailablePhoneNumbersResponse response) { //... }; });
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 viaSearchAvailablePhoneNumbersRequest.builder()
- Parameters:
searchAvailablePhoneNumbersRequest
- AConsumer
that will call methods onSearchAvailablePhoneNumbersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
sendChannelMessage
@Deprecated default CompletableFuture<SendChannelMessageResponse> sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest) Deprecated.Replaced by SendChannelMessage in the Amazon Chime SDK Messaging NamespaceSends a message to a particular channel that the member is a part of.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
sendChannelMessageRequest
-- Returns:
- A Java Future containing the result of the SendChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
sendChannelMessage
@Deprecated default CompletableFuture<SendChannelMessageResponse> sendChannelMessage(Consumer<SendChannelMessageRequest.Builder> sendChannelMessageRequest) Deprecated.Replaced by SendChannelMessage in the Amazon Chime SDK Messaging NamespaceSends a message to a particular channel that the member is a part of.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaSendChannelMessageRequest.builder()
- Parameters:
sendChannelMessageRequest
- AConsumer
that will call methods onSendChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
startMeetingTranscription
@Deprecated default CompletableFuture<StartMeetingTranscriptionResponse> startMeetingTranscription(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest) Deprecated.Replaced by StartMeetingTranscription in the Amazon Chime SDK Meetings NamespaceStarts 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 theBadRequestException
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.
- Parameters:
startMeetingTranscriptionRequest
-- Returns:
- A Java Future containing the result of the StartMeetingTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
startMeetingTranscription
@Deprecated default CompletableFuture<StartMeetingTranscriptionResponse> startMeetingTranscription(Consumer<StartMeetingTranscriptionRequest.Builder> startMeetingTranscriptionRequest) Deprecated.Replaced by StartMeetingTranscription in the Amazon Chime SDK Meetings NamespaceStarts 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 theBadRequestException
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 viaStartMeetingTranscriptionRequest.builder()
- Parameters:
startMeetingTranscriptionRequest
- AConsumer
that will call methods onStartMeetingTranscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartMeetingTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
stopMeetingTranscription
@Deprecated default CompletableFuture<StopMeetingTranscriptionResponse> stopMeetingTranscription(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest) Deprecated.Replaced by StopMeetingTranscription in the Amazon Chime SDK Meetings NamespaceStops 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.
- Parameters:
stopMeetingTranscriptionRequest
-- Returns:
- A Java Future containing the result of the StopMeetingTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
stopMeetingTranscription
@Deprecated default CompletableFuture<StopMeetingTranscriptionResponse> stopMeetingTranscription(Consumer<StopMeetingTranscriptionRequest.Builder> stopMeetingTranscriptionRequest) Deprecated.Replaced by StopMeetingTranscription in the Amazon Chime SDK Meetings NamespaceStops 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 viaStopMeetingTranscriptionRequest.builder()
- Parameters:
stopMeetingTranscriptionRequest
- AConsumer
that will call methods onStopMeetingTranscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopMeetingTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagAttendee
@Deprecated default CompletableFuture<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.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.
- Parameters:
tagAttendeeRequest
-- Returns:
- A Java Future containing the result of the TagAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagAttendee
@Deprecated default CompletableFuture<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.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 viaTagAttendeeRequest.builder()
- Parameters:
tagAttendeeRequest
- AConsumer
that will call methods onTagAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagMeeting
@Deprecated default CompletableFuture<TagMeetingResponse> tagMeeting(TagMeetingRequest tagMeetingRequest) Deprecated.Use TagResource in the Amazon Chime SDK Meetings Namespace.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.
- Parameters:
tagMeetingRequest
-- Returns:
- A Java Future containing the result of the TagMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagMeeting
@Deprecated default CompletableFuture<TagMeetingResponse> tagMeeting(Consumer<TagMeetingRequest.Builder> tagMeetingRequest) Deprecated.Use TagResource in the Amazon Chime SDK Meetings Namespace.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 viaTagMeetingRequest.builder()
- Parameters:
tagMeetingRequest
- AConsumer
that will call methods onTagMeetingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagResource
@Deprecated default CompletableFuture<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 NamespacesApplies 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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
tagResource
@Deprecated default CompletableFuture<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 NamespacesApplies 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagAttendee
@Deprecated default CompletableFuture<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.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.
- Parameters:
untagAttendeeRequest
-- Returns:
- A Java Future containing the result of the UntagAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagAttendee
@Deprecated default CompletableFuture<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.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 viaUntagAttendeeRequest.builder()
- Parameters:
untagAttendeeRequest
- AConsumer
that will call methods onUntagAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagMeeting
@Deprecated default CompletableFuture<UntagMeetingResponse> untagMeeting(UntagMeetingRequest untagMeetingRequest) Deprecated.Use UntagResource in the Amazon Chime SDK Meetings Namespace.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.
- Parameters:
untagMeetingRequest
-- Returns:
- A Java Future containing the result of the UntagMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagMeeting
@Deprecated default CompletableFuture<UntagMeetingResponse> untagMeeting(Consumer<UntagMeetingRequest.Builder> untagMeetingRequest) Deprecated.Use UntagResource in the Amazon Chime SDK Meetings Namespace.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 viaUntagMeetingRequest.builder()
- Parameters:
untagMeetingRequest
- AConsumer
that will call methods onUntagMeetingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagResource
@Deprecated default CompletableFuture<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 NamespacesUntags 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.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
untagResource
@Deprecated default CompletableFuture<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 NamespacesUntags 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccount
default CompletableFuture<UpdateAccountResponse> updateAccount(UpdateAccountRequest updateAccountRequest) Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
- Parameters:
updateAccountRequest
-- Returns:
- A Java Future containing the result of the UpdateAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccount
default CompletableFuture<UpdateAccountResponse> updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest) 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 viaUpdateAccountRequest.builder()
- Parameters:
updateAccountRequest
- AConsumer
that will call methods onUpdateAccountRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccountSettings
default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) 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.
- Parameters:
updateAccountSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAccountSettings
default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) 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 viaUpdateAccountSettingsRequest.builder()
- Parameters:
updateAccountSettingsRequest
- AConsumer
that will call methods onUpdateAccountSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAppInstance
@Deprecated default CompletableFuture<UpdateAppInstanceResponse> updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest) Deprecated.Replaced by UpdateAppInstance in the Amazon Chime SDK Identity NamespaceUpdates
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.
- Parameters:
updateAppInstanceRequest
-- Returns:
- A Java Future containing the result of the UpdateAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAppInstance
@Deprecated default CompletableFuture<UpdateAppInstanceResponse> updateAppInstance(Consumer<UpdateAppInstanceRequest.Builder> updateAppInstanceRequest) Deprecated.Replaced by UpdateAppInstance in the Amazon Chime SDK Identity NamespaceUpdates
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 viaUpdateAppInstanceRequest.builder()
- Parameters:
updateAppInstanceRequest
- AConsumer
that will call methods onUpdateAppInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAppInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAppInstanceUser
@Deprecated default CompletableFuture<UpdateAppInstanceUserResponse> updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest) Deprecated.Replaced by UpdateAppInstanceUser in the Amazon Chime SDK Identity NamespaceUpdates 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.
- Parameters:
updateAppInstanceUserRequest
-- Returns:
- A Java Future containing the result of the UpdateAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateAppInstanceUser
@Deprecated default CompletableFuture<UpdateAppInstanceUserResponse> updateAppInstanceUser(Consumer<UpdateAppInstanceUserRequest.Builder> updateAppInstanceUserRequest) Deprecated.Replaced by UpdateAppInstanceUser in the Amazon Chime SDK Identity NamespaceUpdates 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 viaUpdateAppInstanceUserRequest.builder()
- Parameters:
updateAppInstanceUserRequest
- AConsumer
that will call methods onUpdateAppInstanceUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAppInstanceUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateBot
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
- Parameters:
updateBotRequest
-- Returns:
- A Java Future containing the result of the UpdateBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateBot
default CompletableFuture<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.
This is a convenience which creates an instance of the
UpdateBotRequest.Builder
avoiding the need to create one manually viaUpdateBotRequest.builder()
- Parameters:
updateBotRequest
- AConsumer
that will call methods onUpdateBotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateBot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateChannel
@Deprecated default CompletableFuture<UpdateChannelResponse> updateChannel(UpdateChannelRequest updateChannelRequest) Deprecated.Replaced by UpdateChannel in the Amazon Chime SDK Messaging NamespaceUpdate a channel's attributes.
Restriction: You can't change a channel's privacy.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
updateChannelRequest
-- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateChannel
@Deprecated default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Deprecated.Replaced by UpdateChannel in the Amazon Chime SDK Messaging NamespaceUpdate a channel's attributes.
Restriction: You can't change a channel's privacy.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaUpdateChannelRequest.builder()
- Parameters:
updateChannelRequest
- AConsumer
that will call methods onUpdateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateChannelMessage
@Deprecated default CompletableFuture<UpdateChannelMessageResponse> updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest) Deprecated.Replaced by UpdateChannelMessage in the Amazon Chime SDK Messaging NamespaceUpdates the content of a message.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
updateChannelMessageRequest
-- Returns:
- A Java Future containing the result of the UpdateChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateChannelMessage
@Deprecated default CompletableFuture<UpdateChannelMessageResponse> updateChannelMessage(Consumer<UpdateChannelMessageRequest.Builder> updateChannelMessageRequest) Deprecated.Replaced by UpdateChannelMessage in the Amazon Chime SDK Messaging NamespaceUpdates the content of a message.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaUpdateChannelMessageRequest.builder()
- Parameters:
updateChannelMessageRequest
- AConsumer
that will call methods onUpdateChannelMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannelMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateChannelReadMarker
@Deprecated default CompletableFuture<UpdateChannelReadMarkerResponse> updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest) Deprecated.Replaced by UpdateChannelReadMarker in the Amazon Chime SDK Messaging NamespaceThe details of the time when a user last read messages in a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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.
- Parameters:
updateChannelReadMarkerRequest
-- Returns:
- A Java Future containing the result of the UpdateChannelReadMarker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateChannelReadMarker
@Deprecated default CompletableFuture<UpdateChannelReadMarkerResponse> updateChannelReadMarker(Consumer<UpdateChannelReadMarkerRequest.Builder> updateChannelReadMarkerRequest) Deprecated.Replaced by UpdateChannelReadMarker in the Amazon Chime SDK Messaging NamespaceThe details of the time when a user last read messages in a channel.
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
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 viaUpdateChannelReadMarkerRequest.builder()
- Parameters:
updateChannelReadMarkerRequest
- AConsumer
that will call methods onUpdateChannelReadMarkerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannelReadMarker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateGlobalSettings
default CompletableFuture<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.
- Parameters:
updateGlobalSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateGlobalSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateGlobalSettings
default CompletableFuture<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.
This is a convenience which creates an instance of the
UpdateGlobalSettingsRequest.Builder
avoiding the need to create one manually viaUpdateGlobalSettingsRequest.builder()
- Parameters:
updateGlobalSettingsRequest
- AConsumer
that will call methods onUpdateGlobalSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGlobalSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updatePhoneNumber
default CompletableFuture<UpdatePhoneNumberResponse> updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest) 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.
- Parameters:
updatePhoneNumberRequest
-- Returns:
- A Java Future containing the result of the UpdatePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updatePhoneNumber
default CompletableFuture<UpdatePhoneNumberResponse> updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) 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 viaUpdatePhoneNumberRequest.builder()
- Parameters:
updatePhoneNumberRequest
- AConsumer
that will call methods onUpdatePhoneNumberRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updatePhoneNumberSettings
default CompletableFuture<UpdatePhoneNumberSettingsResponse> updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest) 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.
- Parameters:
updatePhoneNumberSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdatePhoneNumberSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updatePhoneNumberSettings
default CompletableFuture<UpdatePhoneNumberSettingsResponse> updatePhoneNumberSettings(Consumer<UpdatePhoneNumberSettingsRequest.Builder> updatePhoneNumberSettingsRequest) 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 viaUpdatePhoneNumberSettingsRequest.builder()
- Parameters:
updatePhoneNumberSettingsRequest
- AConsumer
that will call methods onUpdatePhoneNumberSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePhoneNumberSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateProxySession
@Deprecated default CompletableFuture<UpdateProxySessionResponse> updateProxySession(UpdateProxySessionRequest updateProxySessionRequest) Deprecated.Replaced by UpdateProxySession in the Amazon Chime SDK Voice NamespaceUpdates 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.
- Parameters:
updateProxySessionRequest
-- Returns:
- A Java Future containing the result of the UpdateProxySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateProxySession
@Deprecated default CompletableFuture<UpdateProxySessionResponse> updateProxySession(Consumer<UpdateProxySessionRequest.Builder> updateProxySessionRequest) Deprecated.Replaced by UpdateProxySession in the Amazon Chime SDK Voice NamespaceUpdates 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 viaUpdateProxySessionRequest.builder()
- Parameters:
updateProxySessionRequest
- AConsumer
that will call methods onUpdateProxySessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProxySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateRoom
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
- Parameters:
updateRoomRequest
-- Returns:
- A Java Future containing the result of the UpdateRoom operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateRoom
default CompletableFuture<UpdateRoomResponse> updateRoom(Consumer<UpdateRoomRequest.Builder> updateRoomRequest) 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 viaUpdateRoomRequest.builder()
- Parameters:
updateRoomRequest
- AConsumer
that will call methods onUpdateRoomRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRoom operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateRoomMembership
default CompletableFuture<UpdateRoomMembershipResponse> updateRoomMembership(UpdateRoomMembershipRequest updateRoomMembershipRequest) 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.
- Parameters:
updateRoomMembershipRequest
-- Returns:
- A Java Future containing the result of the UpdateRoomMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateRoomMembership
default CompletableFuture<UpdateRoomMembershipResponse> updateRoomMembership(Consumer<UpdateRoomMembershipRequest.Builder> updateRoomMembershipRequest) 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 viaUpdateRoomMembershipRequest.builder()
- Parameters:
updateRoomMembershipRequest
- AConsumer
that will call methods onUpdateRoomMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRoomMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSipMediaApplication
@Deprecated default CompletableFuture<UpdateSipMediaApplicationResponse> updateSipMediaApplication(UpdateSipMediaApplicationRequest updateSipMediaApplicationRequest) Deprecated.Replaced by UpdateSipMediaApplication in the Amazon Chime SDK Voice NamespaceUpdates 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.
- Parameters:
updateSipMediaApplicationRequest
-- Returns:
- A Java Future containing the result of the UpdateSipMediaApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSipMediaApplication
@Deprecated default CompletableFuture<UpdateSipMediaApplicationResponse> updateSipMediaApplication(Consumer<UpdateSipMediaApplicationRequest.Builder> updateSipMediaApplicationRequest) Deprecated.Replaced by UpdateSipMediaApplication in the Amazon Chime SDK Voice NamespaceUpdates 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 viaUpdateSipMediaApplicationRequest.builder()
- Parameters:
updateSipMediaApplicationRequest
- AConsumer
that will call methods onUpdateSipMediaApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSipMediaApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSipMediaApplicationCall
@Deprecated default CompletableFuture<UpdateSipMediaApplicationCallResponse> updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest updateSipMediaApplicationCallRequest) Deprecated.Replaced by UpdateSipMediaApplicationCall in the Amazon Chime SDK Voice NamespaceInvokes 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.
- Parameters:
updateSipMediaApplicationCallRequest
-- Returns:
- A Java Future containing the result of the UpdateSipMediaApplicationCall operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSipMediaApplicationCall
@Deprecated default CompletableFuture<UpdateSipMediaApplicationCallResponse> updateSipMediaApplicationCall(Consumer<UpdateSipMediaApplicationCallRequest.Builder> updateSipMediaApplicationCallRequest) Deprecated.Replaced by UpdateSipMediaApplicationCall in the Amazon Chime SDK Voice NamespaceInvokes 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 viaUpdateSipMediaApplicationCallRequest.builder()
- Parameters:
updateSipMediaApplicationCallRequest
- AConsumer
that will call methods onUpdateSipMediaApplicationCallRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSipMediaApplicationCall operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSipRule
@Deprecated default CompletableFuture<UpdateSipRuleResponse> updateSipRule(UpdateSipRuleRequest updateSipRuleRequest) Deprecated.Replaced by UpdateSipRule in the Amazon Chime SDK Voice NamespaceUpdates 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.
- Parameters:
updateSipRuleRequest
-- Returns:
- A Java Future containing the result of the UpdateSipRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateSipRule
@Deprecated default CompletableFuture<UpdateSipRuleResponse> updateSipRule(Consumer<UpdateSipRuleRequest.Builder> updateSipRuleRequest) Deprecated.Replaced by UpdateSipRule in the Amazon Chime SDK Voice NamespaceUpdates 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 viaUpdateSipRuleRequest.builder()
- Parameters:
updateSipRuleRequest
- AConsumer
that will call methods onUpdateSipRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSipRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateUser
Updates user details for a specified user ID. Currently, only
LicenseType
updates are supported for this action.- Parameters:
updateUserRequest
-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) 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 viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateUserSettings
default CompletableFuture<UpdateUserSettingsResponse> updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest) Updates the settings for the specified user, such as phone number settings.
- Parameters:
updateUserSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateUserSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateUserSettings
default CompletableFuture<UpdateUserSettingsResponse> updateUserSettings(Consumer<UpdateUserSettingsRequest.Builder> updateUserSettingsRequest) 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 viaUpdateUserSettingsRequest.builder()
- Parameters:
updateUserSettingsRequest
- AConsumer
that will call methods onUpdateUserSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateUserSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateVoiceConnector
@Deprecated default CompletableFuture<UpdateVoiceConnectorResponse> updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest) Deprecated.Replaced by UpdateVoiceConnector in the Amazon Chime SDK Voice NamespaceUpdates 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.
- Parameters:
updateVoiceConnectorRequest
-- Returns:
- A Java Future containing the result of the UpdateVoiceConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateVoiceConnector
@Deprecated default CompletableFuture<UpdateVoiceConnectorResponse> updateVoiceConnector(Consumer<UpdateVoiceConnectorRequest.Builder> updateVoiceConnectorRequest) Deprecated.Replaced by UpdateVoiceConnector in the Amazon Chime SDK Voice NamespaceUpdates 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 viaUpdateVoiceConnectorRequest.builder()
- Parameters:
updateVoiceConnectorRequest
- AConsumer
that will call methods onUpdateVoiceConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateVoiceConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateVoiceConnectorGroup
@Deprecated default CompletableFuture<UpdateVoiceConnectorGroupResponse> updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest updateVoiceConnectorGroupRequest) Deprecated.Replaced by UpdateVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceUpdates 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.
- Parameters:
updateVoiceConnectorGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateVoiceConnectorGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateVoiceConnectorGroup
@Deprecated default CompletableFuture<UpdateVoiceConnectorGroupResponse> updateVoiceConnectorGroup(Consumer<UpdateVoiceConnectorGroupRequest.Builder> updateVoiceConnectorGroupRequest) Deprecated.Replaced by UpdateVoiceConnectorGroup in the Amazon Chime SDK Voice NamespaceUpdates 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 viaUpdateVoiceConnectorGroupRequest.builder()
- Parameters:
updateVoiceConnectorGroupRequest
- AConsumer
that will call methods onUpdateVoiceConnectorGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateVoiceConnectorGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
validateE911Address
@Deprecated default CompletableFuture<ValidateE911AddressResponse> validateE911Address(ValidateE911AddressRequest validateE911AddressRequest) Deprecated.Replaced by ValidateE911Address in the Amazon Chime SDK Voice NamespaceValidates 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.
- Parameters:
validateE911AddressRequest
-- Returns:
- A Java Future containing the result of the ValidateE911Address operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
validateE911Address
@Deprecated default CompletableFuture<ValidateE911AddressResponse> validateE911Address(Consumer<ValidateE911AddressRequest.Builder> validateE911AddressRequest) Deprecated.Replaced by ValidateE911Address in the Amazon Chime SDK Voice NamespaceValidates 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 viaValidateE911AddressRequest.builder()
- Parameters:
validateE911AddressRequest
- AConsumer
that will call methods onValidateE911AddressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ValidateE911Address operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aChimeAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aChimeAsyncClient
.
-