Interface MailManagerAsyncClient
- 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.
The Amazon SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service (SES).
Mail Manager is a set of Amazon SES email gateway features designed to help you strengthen your organization's email infrastructure, simplify email workflow management, and streamline email compliance control. To learn more, see the Mail Manager chapter in the Amazon SES Developer Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aMailManagerAsyncClient
.static MailManagerAsyncClient
create()
Create aMailManagerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAddonInstance
(Consumer<CreateAddonInstanceRequest.Builder> createAddonInstanceRequest) Creates an Add On instance for the subscription indicated in the request.createAddonInstance
(CreateAddonInstanceRequest createAddonInstanceRequest) Creates an Add On instance for the subscription indicated in the request.createAddonSubscription
(Consumer<CreateAddonSubscriptionRequest.Builder> createAddonSubscriptionRequest) Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing.createAddonSubscription
(CreateAddonSubscriptionRequest createAddonSubscriptionRequest) Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing.createAddressList
(Consumer<CreateAddressListRequest.Builder> createAddressListRequest) Creates a new address list.createAddressList
(CreateAddressListRequest createAddressListRequest) Creates a new address list.createAddressListImportJob
(Consumer<CreateAddressListImportJobRequest.Builder> createAddressListImportJobRequest) Creates an import job for an address list.createAddressListImportJob
(CreateAddressListImportJobRequest createAddressListImportJobRequest) Creates an import job for an address list.default CompletableFuture
<CreateArchiveResponse> createArchive
(Consumer<CreateArchiveRequest.Builder> createArchiveRequest) Creates a new email archive resource for storing and retaining emails.default CompletableFuture
<CreateArchiveResponse> createArchive
(CreateArchiveRequest createArchiveRequest) Creates a new email archive resource for storing and retaining emails.createIngressPoint
(Consumer<CreateIngressPointRequest.Builder> createIngressPointRequest) Provision a new ingress endpoint resource.createIngressPoint
(CreateIngressPointRequest createIngressPointRequest) Provision a new ingress endpoint resource.default CompletableFuture
<CreateRelayResponse> createRelay
(Consumer<CreateRelayRequest.Builder> createRelayRequest) Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.default CompletableFuture
<CreateRelayResponse> createRelay
(CreateRelayRequest createRelayRequest) Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.default CompletableFuture
<CreateRuleSetResponse> createRuleSet
(Consumer<CreateRuleSetRequest.Builder> createRuleSetRequest) Provision a new rule set.default CompletableFuture
<CreateRuleSetResponse> createRuleSet
(CreateRuleSetRequest createRuleSetRequest) Provision a new rule set.createTrafficPolicy
(Consumer<CreateTrafficPolicyRequest.Builder> createTrafficPolicyRequest) Provision a new traffic policy resource.createTrafficPolicy
(CreateTrafficPolicyRequest createTrafficPolicyRequest) Provision a new traffic policy resource.deleteAddonInstance
(Consumer<DeleteAddonInstanceRequest.Builder> deleteAddonInstanceRequest) Deletes an Add On instance.deleteAddonInstance
(DeleteAddonInstanceRequest deleteAddonInstanceRequest) Deletes an Add On instance.deleteAddonSubscription
(Consumer<DeleteAddonSubscriptionRequest.Builder> deleteAddonSubscriptionRequest) Deletes an Add On subscription.deleteAddonSubscription
(DeleteAddonSubscriptionRequest deleteAddonSubscriptionRequest) Deletes an Add On subscription.deleteAddressList
(Consumer<DeleteAddressListRequest.Builder> deleteAddressListRequest) Deletes an address list.deleteAddressList
(DeleteAddressListRequest deleteAddressListRequest) Deletes an address list.default CompletableFuture
<DeleteArchiveResponse> deleteArchive
(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest) Initiates deletion of an email archive.default CompletableFuture
<DeleteArchiveResponse> deleteArchive
(DeleteArchiveRequest deleteArchiveRequest) Initiates deletion of an email archive.deleteIngressPoint
(Consumer<DeleteIngressPointRequest.Builder> deleteIngressPointRequest) Delete an ingress endpoint resource.deleteIngressPoint
(DeleteIngressPointRequest deleteIngressPointRequest) Delete an ingress endpoint resource.default CompletableFuture
<DeleteRelayResponse> deleteRelay
(Consumer<DeleteRelayRequest.Builder> deleteRelayRequest) Deletes an existing relay resource.default CompletableFuture
<DeleteRelayResponse> deleteRelay
(DeleteRelayRequest deleteRelayRequest) Deletes an existing relay resource.default CompletableFuture
<DeleteRuleSetResponse> deleteRuleSet
(Consumer<DeleteRuleSetRequest.Builder> deleteRuleSetRequest) Delete a rule set.default CompletableFuture
<DeleteRuleSetResponse> deleteRuleSet
(DeleteRuleSetRequest deleteRuleSetRequest) Delete a rule set.deleteTrafficPolicy
(Consumer<DeleteTrafficPolicyRequest.Builder> deleteTrafficPolicyRequest) Delete a traffic policy resource.deleteTrafficPolicy
(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest) Delete a traffic policy resource.deregisterMemberFromAddressList
(Consumer<DeregisterMemberFromAddressListRequest.Builder> deregisterMemberFromAddressListRequest) Removes a member from an address list.deregisterMemberFromAddressList
(DeregisterMemberFromAddressListRequest deregisterMemberFromAddressListRequest) Removes a member from an address list.getAddonInstance
(Consumer<GetAddonInstanceRequest.Builder> getAddonInstanceRequest) Gets detailed information about an Add On instance.getAddonInstance
(GetAddonInstanceRequest getAddonInstanceRequest) Gets detailed information about an Add On instance.getAddonSubscription
(Consumer<GetAddonSubscriptionRequest.Builder> getAddonSubscriptionRequest) Gets detailed information about an Add On subscription.getAddonSubscription
(GetAddonSubscriptionRequest getAddonSubscriptionRequest) Gets detailed information about an Add On subscription.default CompletableFuture
<GetAddressListResponse> getAddressList
(Consumer<GetAddressListRequest.Builder> getAddressListRequest) Fetch attributes of an address list.default CompletableFuture
<GetAddressListResponse> getAddressList
(GetAddressListRequest getAddressListRequest) Fetch attributes of an address list.getAddressListImportJob
(Consumer<GetAddressListImportJobRequest.Builder> getAddressListImportJobRequest) Fetch attributes of an import job.getAddressListImportJob
(GetAddressListImportJobRequest getAddressListImportJobRequest) Fetch attributes of an import job.default CompletableFuture
<GetArchiveResponse> getArchive
(Consumer<GetArchiveRequest.Builder> getArchiveRequest) Retrieves the full details and current state of a specified email archive.default CompletableFuture
<GetArchiveResponse> getArchive
(GetArchiveRequest getArchiveRequest) Retrieves the full details and current state of a specified email archive.getArchiveExport
(Consumer<GetArchiveExportRequest.Builder> getArchiveExportRequest) Retrieves the details and current status of a specific email archive export job.getArchiveExport
(GetArchiveExportRequest getArchiveExportRequest) Retrieves the details and current status of a specific email archive export job.getArchiveMessage
(Consumer<GetArchiveMessageRequest.Builder> getArchiveMessageRequest) Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.getArchiveMessage
(GetArchiveMessageRequest getArchiveMessageRequest) Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.getArchiveMessageContent
(Consumer<GetArchiveMessageContentRequest.Builder> getArchiveMessageContentRequest) Returns the textual content of a specific email message stored in the archive.getArchiveMessageContent
(GetArchiveMessageContentRequest getArchiveMessageContentRequest) Returns the textual content of a specific email message stored in the archive.getArchiveSearch
(Consumer<GetArchiveSearchRequest.Builder> getArchiveSearchRequest) Retrieves the details and current status of a specific email archive search job.getArchiveSearch
(GetArchiveSearchRequest getArchiveSearchRequest) Retrieves the details and current status of a specific email archive search job.getArchiveSearchResults
(Consumer<GetArchiveSearchResultsRequest.Builder> getArchiveSearchResultsRequest) Returns the results of a completed email archive search job.getArchiveSearchResults
(GetArchiveSearchResultsRequest getArchiveSearchResultsRequest) Returns the results of a completed email archive search job.default CompletableFuture
<GetIngressPointResponse> getIngressPoint
(Consumer<GetIngressPointRequest.Builder> getIngressPointRequest) Fetch ingress endpoint resource attributes.default CompletableFuture
<GetIngressPointResponse> getIngressPoint
(GetIngressPointRequest getIngressPointRequest) Fetch ingress endpoint resource attributes.getMemberOfAddressList
(Consumer<GetMemberOfAddressListRequest.Builder> getMemberOfAddressListRequest) Fetch attributes of a member in an address list.getMemberOfAddressList
(GetMemberOfAddressListRequest getMemberOfAddressListRequest) Fetch attributes of a member in an address list.default CompletableFuture
<GetRelayResponse> getRelay
(Consumer<GetRelayRequest.Builder> getRelayRequest) Fetch the relay resource and it's attributes.default CompletableFuture
<GetRelayResponse> getRelay
(GetRelayRequest getRelayRequest) Fetch the relay resource and it's attributes.default CompletableFuture
<GetRuleSetResponse> getRuleSet
(Consumer<GetRuleSetRequest.Builder> getRuleSetRequest) Fetch attributes of a rule set.default CompletableFuture
<GetRuleSetResponse> getRuleSet
(GetRuleSetRequest getRuleSetRequest) Fetch attributes of a rule set.getTrafficPolicy
(Consumer<GetTrafficPolicyRequest.Builder> getTrafficPolicyRequest) Fetch attributes of a traffic policy resource.getTrafficPolicy
(GetTrafficPolicyRequest getTrafficPolicyRequest) Fetch attributes of a traffic policy resource.listAddonInstances
(Consumer<ListAddonInstancesRequest.Builder> listAddonInstancesRequest) Lists all Add On instances in your account.listAddonInstances
(ListAddonInstancesRequest listAddonInstancesRequest) Lists all Add On instances in your account.default ListAddonInstancesPublisher
listAddonInstancesPaginator
(Consumer<ListAddonInstancesRequest.Builder> listAddonInstancesRequest) This is a variant oflistAddonInstances(software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesRequest)
operation.default ListAddonInstancesPublisher
listAddonInstancesPaginator
(ListAddonInstancesRequest listAddonInstancesRequest) This is a variant oflistAddonInstances(software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesRequest)
operation.listAddonSubscriptions
(Consumer<ListAddonSubscriptionsRequest.Builder> listAddonSubscriptionsRequest) Lists all Add On subscriptions in your account.listAddonSubscriptions
(ListAddonSubscriptionsRequest listAddonSubscriptionsRequest) Lists all Add On subscriptions in your account.default ListAddonSubscriptionsPublisher
listAddonSubscriptionsPaginator
(Consumer<ListAddonSubscriptionsRequest.Builder> listAddonSubscriptionsRequest) This is a variant oflistAddonSubscriptions(software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsRequest)
operation.default ListAddonSubscriptionsPublisher
listAddonSubscriptionsPaginator
(ListAddonSubscriptionsRequest listAddonSubscriptionsRequest) This is a variant oflistAddonSubscriptions(software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsRequest)
operation.listAddressListImportJobs
(Consumer<ListAddressListImportJobsRequest.Builder> listAddressListImportJobsRequest) Lists jobs for an address list.listAddressListImportJobs
(ListAddressListImportJobsRequest listAddressListImportJobsRequest) Lists jobs for an address list.listAddressListImportJobsPaginator
(Consumer<ListAddressListImportJobsRequest.Builder> listAddressListImportJobsRequest) This is a variant oflistAddressListImportJobs(software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsRequest)
operation.listAddressListImportJobsPaginator
(ListAddressListImportJobsRequest listAddressListImportJobsRequest) This is a variant oflistAddressListImportJobs(software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsRequest)
operation.listAddressLists
(Consumer<ListAddressListsRequest.Builder> listAddressListsRequest) Lists address lists for this account.listAddressLists
(ListAddressListsRequest listAddressListsRequest) Lists address lists for this account.default ListAddressListsPublisher
listAddressListsPaginator
(Consumer<ListAddressListsRequest.Builder> listAddressListsRequest) This is a variant oflistAddressLists(software.amazon.awssdk.services.mailmanager.model.ListAddressListsRequest)
operation.default ListAddressListsPublisher
listAddressListsPaginator
(ListAddressListsRequest listAddressListsRequest) This is a variant oflistAddressLists(software.amazon.awssdk.services.mailmanager.model.ListAddressListsRequest)
operation.listArchiveExports
(Consumer<ListArchiveExportsRequest.Builder> listArchiveExportsRequest) Returns a list of email archive export jobs.listArchiveExports
(ListArchiveExportsRequest listArchiveExportsRequest) Returns a list of email archive export jobs.default ListArchiveExportsPublisher
listArchiveExportsPaginator
(Consumer<ListArchiveExportsRequest.Builder> listArchiveExportsRequest) This is a variant oflistArchiveExports(software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsRequest)
operation.default ListArchiveExportsPublisher
listArchiveExportsPaginator
(ListArchiveExportsRequest listArchiveExportsRequest) This is a variant oflistArchiveExports(software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsRequest)
operation.default CompletableFuture
<ListArchivesResponse> listArchives
(Consumer<ListArchivesRequest.Builder> listArchivesRequest) Returns a list of all email archives in your account.default CompletableFuture
<ListArchivesResponse> listArchives
(ListArchivesRequest listArchivesRequest) Returns a list of all email archives in your account.listArchiveSearches
(Consumer<ListArchiveSearchesRequest.Builder> listArchiveSearchesRequest) Returns a list of email archive search jobs.listArchiveSearches
(ListArchiveSearchesRequest listArchiveSearchesRequest) Returns a list of email archive search jobs.default ListArchiveSearchesPublisher
listArchiveSearchesPaginator
(Consumer<ListArchiveSearchesRequest.Builder> listArchiveSearchesRequest) This is a variant oflistArchiveSearches(software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesRequest)
operation.default ListArchiveSearchesPublisher
listArchiveSearchesPaginator
(ListArchiveSearchesRequest listArchiveSearchesRequest) This is a variant oflistArchiveSearches(software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesRequest)
operation.default ListArchivesPublisher
listArchivesPaginator
(Consumer<ListArchivesRequest.Builder> listArchivesRequest) This is a variant oflistArchives(software.amazon.awssdk.services.mailmanager.model.ListArchivesRequest)
operation.default ListArchivesPublisher
listArchivesPaginator
(ListArchivesRequest listArchivesRequest) This is a variant oflistArchives(software.amazon.awssdk.services.mailmanager.model.ListArchivesRequest)
operation.listIngressPoints
(Consumer<ListIngressPointsRequest.Builder> listIngressPointsRequest) List all ingress endpoint resources.listIngressPoints
(ListIngressPointsRequest listIngressPointsRequest) List all ingress endpoint resources.default ListIngressPointsPublisher
listIngressPointsPaginator
(Consumer<ListIngressPointsRequest.Builder> listIngressPointsRequest) This is a variant oflistIngressPoints(software.amazon.awssdk.services.mailmanager.model.ListIngressPointsRequest)
operation.default ListIngressPointsPublisher
listIngressPointsPaginator
(ListIngressPointsRequest listIngressPointsRequest) This is a variant oflistIngressPoints(software.amazon.awssdk.services.mailmanager.model.ListIngressPointsRequest)
operation.listMembersOfAddressList
(Consumer<ListMembersOfAddressListRequest.Builder> listMembersOfAddressListRequest) Lists members of an address list.listMembersOfAddressList
(ListMembersOfAddressListRequest listMembersOfAddressListRequest) Lists members of an address list.listMembersOfAddressListPaginator
(Consumer<ListMembersOfAddressListRequest.Builder> listMembersOfAddressListRequest) This is a variant oflistMembersOfAddressList(software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListRequest)
operation.listMembersOfAddressListPaginator
(ListMembersOfAddressListRequest listMembersOfAddressListRequest) This is a variant oflistMembersOfAddressList(software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListRequest)
operation.default CompletableFuture
<ListRelaysResponse> listRelays
(Consumer<ListRelaysRequest.Builder> listRelaysRequest) Lists all the existing relay resources.default CompletableFuture
<ListRelaysResponse> listRelays
(ListRelaysRequest listRelaysRequest) Lists all the existing relay resources.default ListRelaysPublisher
listRelaysPaginator
(Consumer<ListRelaysRequest.Builder> listRelaysRequest) This is a variant oflistRelays(software.amazon.awssdk.services.mailmanager.model.ListRelaysRequest)
operation.default ListRelaysPublisher
listRelaysPaginator
(ListRelaysRequest listRelaysRequest) This is a variant oflistRelays(software.amazon.awssdk.services.mailmanager.model.ListRelaysRequest)
operation.default CompletableFuture
<ListRuleSetsResponse> listRuleSets
(Consumer<ListRuleSetsRequest.Builder> listRuleSetsRequest) List rule sets for this account.default CompletableFuture
<ListRuleSetsResponse> listRuleSets
(ListRuleSetsRequest listRuleSetsRequest) List rule sets for this account.default ListRuleSetsPublisher
listRuleSetsPaginator
(Consumer<ListRuleSetsRequest.Builder> listRuleSetsRequest) This is a variant oflistRuleSets(software.amazon.awssdk.services.mailmanager.model.ListRuleSetsRequest)
operation.default ListRuleSetsPublisher
listRuleSetsPaginator
(ListRuleSetsRequest listRuleSetsRequest) This is a variant oflistRuleSets(software.amazon.awssdk.services.mailmanager.model.ListRuleSetsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the list of tags (keys and values) assigned to the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of tags (keys and values) assigned to the resource.listTrafficPolicies
(Consumer<ListTrafficPoliciesRequest.Builder> listTrafficPoliciesRequest) List traffic policy resources.listTrafficPolicies
(ListTrafficPoliciesRequest listTrafficPoliciesRequest) List traffic policy resources.default ListTrafficPoliciesPublisher
listTrafficPoliciesPaginator
(Consumer<ListTrafficPoliciesRequest.Builder> listTrafficPoliciesRequest) This is a variant oflistTrafficPolicies(software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesRequest)
operation.default ListTrafficPoliciesPublisher
listTrafficPoliciesPaginator
(ListTrafficPoliciesRequest listTrafficPoliciesRequest) This is a variant oflistTrafficPolicies(software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesRequest)
operation.registerMemberToAddressList
(Consumer<RegisterMemberToAddressListRequest.Builder> registerMemberToAddressListRequest) Adds a member to an address list.registerMemberToAddressList
(RegisterMemberToAddressListRequest registerMemberToAddressListRequest) Adds a member to an address list.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartAddressListImportJob
(Consumer<StartAddressListImportJobRequest.Builder> startAddressListImportJobRequest) Starts an import job for an address list.startAddressListImportJob
(StartAddressListImportJobRequest startAddressListImportJobRequest) Starts an import job for an address list.startArchiveExport
(Consumer<StartArchiveExportRequest.Builder> startArchiveExportRequest) Initiates an export of emails from the specified archive.startArchiveExport
(StartArchiveExportRequest startArchiveExportRequest) Initiates an export of emails from the specified archive.startArchiveSearch
(Consumer<StartArchiveSearchRequest.Builder> startArchiveSearchRequest) Initiates a search across emails in the specified archive.startArchiveSearch
(StartArchiveSearchRequest startArchiveSearchRequest) Initiates a search across emails in the specified archive.stopAddressListImportJob
(Consumer<StopAddressListImportJobRequest.Builder> stopAddressListImportJobRequest) Stops an ongoing import job for an address list.stopAddressListImportJob
(StopAddressListImportJobRequest stopAddressListImportJobRequest) Stops an ongoing import job for an address list.stopArchiveExport
(Consumer<StopArchiveExportRequest.Builder> stopArchiveExportRequest) Stops an in-progress export of emails from an archive.stopArchiveExport
(StopArchiveExportRequest stopArchiveExportRequest) Stops an in-progress export of emails from an archive.stopArchiveSearch
(Consumer<StopArchiveSearchRequest.Builder> stopArchiveSearchRequest) Stops an in-progress archive search job.stopArchiveSearch
(StopArchiveSearchRequest stopArchiveSearchRequest) Stops an in-progress archive search job.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags (keys and values) to a specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags (keys and values) to a specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.default CompletableFuture
<UpdateArchiveResponse> updateArchive
(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest) Updates the attributes of an existing email archive.default CompletableFuture
<UpdateArchiveResponse> updateArchive
(UpdateArchiveRequest updateArchiveRequest) Updates the attributes of an existing email archive.updateIngressPoint
(Consumer<UpdateIngressPointRequest.Builder> updateIngressPointRequest) Update attributes of a provisioned ingress endpoint resource.updateIngressPoint
(UpdateIngressPointRequest updateIngressPointRequest) Update attributes of a provisioned ingress endpoint resource.default CompletableFuture
<UpdateRelayResponse> updateRelay
(Consumer<UpdateRelayRequest.Builder> updateRelayRequest) Updates the attributes of an existing relay resource.default CompletableFuture
<UpdateRelayResponse> updateRelay
(UpdateRelayRequest updateRelayRequest) Updates the attributes of an existing relay resource.default CompletableFuture
<UpdateRuleSetResponse> updateRuleSet
(Consumer<UpdateRuleSetRequest.Builder> updateRuleSetRequest) Update attributes of an already provisioned rule set.default CompletableFuture
<UpdateRuleSetResponse> updateRuleSet
(UpdateRuleSetRequest updateRuleSetRequest) Update attributes of an already provisioned rule set.updateTrafficPolicy
(Consumer<UpdateTrafficPolicyRequest.Builder> updateTrafficPolicyRequest) Update attributes of an already provisioned traffic policy resource.updateTrafficPolicy
(UpdateTrafficPolicyRequest updateTrafficPolicyRequest) Update attributes of an already provisioned traffic policy resource.Methods 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
-
createAddonInstance
default CompletableFuture<CreateAddonInstanceResponse> createAddonInstance(CreateAddonInstanceRequest createAddonInstanceRequest) Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.
- Parameters:
createAddonInstanceRequest
-- Returns:
- A Java Future containing the result of the CreateAddonInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAddonInstance
default CompletableFuture<CreateAddonInstanceResponse> createAddonInstance(Consumer<CreateAddonInstanceRequest.Builder> createAddonInstanceRequest) Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.
This is a convenience which creates an instance of the
CreateAddonInstanceRequest.Builder
avoiding the need to create one manually viaCreateAddonInstanceRequest.builder()
- Parameters:
createAddonInstanceRequest
- AConsumer
that will call methods onCreateAddonInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAddonInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAddonSubscription
default CompletableFuture<CreateAddonSubscriptionResponse> createAddonSubscription(CreateAddonSubscriptionRequest createAddonSubscriptionRequest) Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.
- Parameters:
createAddonSubscriptionRequest
-- Returns:
- A Java Future containing the result of the CreateAddonSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAddonSubscription
default CompletableFuture<CreateAddonSubscriptionResponse> createAddonSubscription(Consumer<CreateAddonSubscriptionRequest.Builder> createAddonSubscriptionRequest) Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.
This is a convenience which creates an instance of the
CreateAddonSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateAddonSubscriptionRequest.builder()
- Parameters:
createAddonSubscriptionRequest
- AConsumer
that will call methods onCreateAddonSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAddonSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAddressList
default CompletableFuture<CreateAddressListResponse> createAddressList(CreateAddressListRequest createAddressListRequest) Creates a new address list.
- Parameters:
createAddressListRequest
-- Returns:
- A Java Future containing the result of the CreateAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAddressList
default CompletableFuture<CreateAddressListResponse> createAddressList(Consumer<CreateAddressListRequest.Builder> createAddressListRequest) Creates a new address list.
This is a convenience which creates an instance of the
CreateAddressListRequest.Builder
avoiding the need to create one manually viaCreateAddressListRequest.builder()
- Parameters:
createAddressListRequest
- AConsumer
that will call methods onCreateAddressListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAddressListImportJob
default CompletableFuture<CreateAddressListImportJobResponse> createAddressListImportJob(CreateAddressListImportJobRequest createAddressListImportJobRequest) Creates an import job for an address list.
- Parameters:
createAddressListImportJobRequest
-- Returns:
- A Java Future containing the result of the CreateAddressListImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAddressListImportJob
default CompletableFuture<CreateAddressListImportJobResponse> createAddressListImportJob(Consumer<CreateAddressListImportJobRequest.Builder> createAddressListImportJobRequest) Creates an import job for an address list.
This is a convenience which creates an instance of the
CreateAddressListImportJobRequest.Builder
avoiding the need to create one manually viaCreateAddressListImportJobRequest.builder()
- Parameters:
createAddressListImportJobRequest
- AConsumer
that will call methods onCreateAddressListImportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAddressListImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createArchive
default CompletableFuture<CreateArchiveResponse> createArchive(CreateArchiveRequest createArchiveRequest) Creates a new email archive resource for storing and retaining emails.
- Parameters:
createArchiveRequest
- The request to create a new email archive.- Returns:
- A Java Future containing the result of the CreateArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createArchive
default CompletableFuture<CreateArchiveResponse> createArchive(Consumer<CreateArchiveRequest.Builder> createArchiveRequest) Creates a new email archive resource for storing and retaining emails.
This is a convenience which creates an instance of the
CreateArchiveRequest.Builder
avoiding the need to create one manually viaCreateArchiveRequest.builder()
- Parameters:
createArchiveRequest
- AConsumer
that will call methods onCreateArchiveRequest.Builder
to create a request. The request to create a new email archive.- Returns:
- A Java Future containing the result of the CreateArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIngressPoint
default CompletableFuture<CreateIngressPointResponse> createIngressPoint(CreateIngressPointRequest createIngressPointRequest) Provision a new ingress endpoint resource.
- Parameters:
createIngressPointRequest
-- Returns:
- A Java Future containing the result of the CreateIngressPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIngressPoint
default CompletableFuture<CreateIngressPointResponse> createIngressPoint(Consumer<CreateIngressPointRequest.Builder> createIngressPointRequest) Provision a new ingress endpoint resource.
This is a convenience which creates an instance of the
CreateIngressPointRequest.Builder
avoiding the need to create one manually viaCreateIngressPointRequest.builder()
- Parameters:
createIngressPointRequest
- AConsumer
that will call methods onCreateIngressPointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateIngressPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRelay
Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
- Parameters:
createRelayRequest
-- Returns:
- A Java Future containing the result of the CreateRelay operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRelay
default CompletableFuture<CreateRelayResponse> createRelay(Consumer<CreateRelayRequest.Builder> createRelayRequest) Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
This is a convenience which creates an instance of the
CreateRelayRequest.Builder
avoiding the need to create one manually viaCreateRelayRequest.builder()
- Parameters:
createRelayRequest
- AConsumer
that will call methods onCreateRelayRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRelay operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRuleSet
default CompletableFuture<CreateRuleSetResponse> createRuleSet(CreateRuleSetRequest createRuleSetRequest) Provision a new rule set.
- Parameters:
createRuleSetRequest
-- Returns:
- A Java Future containing the result of the CreateRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRuleSet
default CompletableFuture<CreateRuleSetResponse> createRuleSet(Consumer<CreateRuleSetRequest.Builder> createRuleSetRequest) Provision a new rule set.
This is a convenience which creates an instance of the
CreateRuleSetRequest.Builder
avoiding the need to create one manually viaCreateRuleSetRequest.builder()
- Parameters:
createRuleSetRequest
- AConsumer
that will call methods onCreateRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrafficPolicy
default CompletableFuture<CreateTrafficPolicyResponse> createTrafficPolicy(CreateTrafficPolicyRequest createTrafficPolicyRequest) Provision a new traffic policy resource.
- Parameters:
createTrafficPolicyRequest
-- Returns:
- A Java Future containing the result of the CreateTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrafficPolicy
default CompletableFuture<CreateTrafficPolicyResponse> createTrafficPolicy(Consumer<CreateTrafficPolicyRequest.Builder> createTrafficPolicyRequest) Provision a new traffic policy resource.
This is a convenience which creates an instance of the
CreateTrafficPolicyRequest.Builder
avoiding the need to create one manually viaCreateTrafficPolicyRequest.builder()
- Parameters:
createTrafficPolicyRequest
- AConsumer
that will call methods onCreateTrafficPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAddonInstance
default CompletableFuture<DeleteAddonInstanceResponse> deleteAddonInstance(DeleteAddonInstanceRequest deleteAddonInstanceRequest) Deletes an Add On instance.
- Parameters:
deleteAddonInstanceRequest
-- Returns:
- A Java Future containing the result of the DeleteAddonInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAddonInstance
default CompletableFuture<DeleteAddonInstanceResponse> deleteAddonInstance(Consumer<DeleteAddonInstanceRequest.Builder> deleteAddonInstanceRequest) Deletes an Add On instance.
This is a convenience which creates an instance of the
DeleteAddonInstanceRequest.Builder
avoiding the need to create one manually viaDeleteAddonInstanceRequest.builder()
- Parameters:
deleteAddonInstanceRequest
- AConsumer
that will call methods onDeleteAddonInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAddonInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAddonSubscription
default CompletableFuture<DeleteAddonSubscriptionResponse> deleteAddonSubscription(DeleteAddonSubscriptionRequest deleteAddonSubscriptionRequest) Deletes an Add On subscription.
- Parameters:
deleteAddonSubscriptionRequest
-- Returns:
- A Java Future containing the result of the DeleteAddonSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAddonSubscription
default CompletableFuture<DeleteAddonSubscriptionResponse> deleteAddonSubscription(Consumer<DeleteAddonSubscriptionRequest.Builder> deleteAddonSubscriptionRequest) Deletes an Add On subscription.
This is a convenience which creates an instance of the
DeleteAddonSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteAddonSubscriptionRequest.builder()
- Parameters:
deleteAddonSubscriptionRequest
- AConsumer
that will call methods onDeleteAddonSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAddonSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAddressList
default CompletableFuture<DeleteAddressListResponse> deleteAddressList(DeleteAddressListRequest deleteAddressListRequest) Deletes an address list.
- Parameters:
deleteAddressListRequest
-- Returns:
- A Java Future containing the result of the DeleteAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAddressList
default CompletableFuture<DeleteAddressListResponse> deleteAddressList(Consumer<DeleteAddressListRequest.Builder> deleteAddressListRequest) Deletes an address list.
This is a convenience which creates an instance of the
DeleteAddressListRequest.Builder
avoiding the need to create one manually viaDeleteAddressListRequest.builder()
- Parameters:
deleteAddressListRequest
- AConsumer
that will call methods onDeleteAddressListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteArchive
default CompletableFuture<DeleteArchiveResponse> deleteArchive(DeleteArchiveRequest deleteArchiveRequest) Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.
- Parameters:
deleteArchiveRequest
- The request to initiate deletion of an email archive.- Returns:
- A Java Future containing the result of the DeleteArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteArchive
default CompletableFuture<DeleteArchiveResponse> deleteArchive(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest) Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.
This is a convenience which creates an instance of the
DeleteArchiveRequest.Builder
avoiding the need to create one manually viaDeleteArchiveRequest.builder()
- Parameters:
deleteArchiveRequest
- AConsumer
that will call methods onDeleteArchiveRequest.Builder
to create a request. The request to initiate deletion of an email archive.- Returns:
- A Java Future containing the result of the DeleteArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIngressPoint
default CompletableFuture<DeleteIngressPointResponse> deleteIngressPoint(DeleteIngressPointRequest deleteIngressPointRequest) Delete an ingress endpoint resource.
- Parameters:
deleteIngressPointRequest
-- Returns:
- A Java Future containing the result of the DeleteIngressPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIngressPoint
default CompletableFuture<DeleteIngressPointResponse> deleteIngressPoint(Consumer<DeleteIngressPointRequest.Builder> deleteIngressPointRequest) Delete an ingress endpoint resource.
This is a convenience which creates an instance of the
DeleteIngressPointRequest.Builder
avoiding the need to create one manually viaDeleteIngressPointRequest.builder()
- Parameters:
deleteIngressPointRequest
- AConsumer
that will call methods onDeleteIngressPointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteIngressPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRelay
Deletes an existing relay resource.
- Parameters:
deleteRelayRequest
-- Returns:
- A Java Future containing the result of the DeleteRelay operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRelay
default CompletableFuture<DeleteRelayResponse> deleteRelay(Consumer<DeleteRelayRequest.Builder> deleteRelayRequest) Deletes an existing relay resource.
This is a convenience which creates an instance of the
DeleteRelayRequest.Builder
avoiding the need to create one manually viaDeleteRelayRequest.builder()
- Parameters:
deleteRelayRequest
- AConsumer
that will call methods onDeleteRelayRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRelay operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRuleSet
default CompletableFuture<DeleteRuleSetResponse> deleteRuleSet(DeleteRuleSetRequest deleteRuleSetRequest) Delete a rule set.
- Parameters:
deleteRuleSetRequest
-- Returns:
- A Java Future containing the result of the DeleteRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRuleSet
default CompletableFuture<DeleteRuleSetResponse> deleteRuleSet(Consumer<DeleteRuleSetRequest.Builder> deleteRuleSetRequest) Delete a rule set.
This is a convenience which creates an instance of the
DeleteRuleSetRequest.Builder
avoiding the need to create one manually viaDeleteRuleSetRequest.builder()
- Parameters:
deleteRuleSetRequest
- AConsumer
that will call methods onDeleteRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTrafficPolicy
default CompletableFuture<DeleteTrafficPolicyResponse> deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest) Delete a traffic policy resource.
- Parameters:
deleteTrafficPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTrafficPolicy
default CompletableFuture<DeleteTrafficPolicyResponse> deleteTrafficPolicy(Consumer<DeleteTrafficPolicyRequest.Builder> deleteTrafficPolicyRequest) Delete a traffic policy resource.
This is a convenience which creates an instance of the
DeleteTrafficPolicyRequest.Builder
avoiding the need to create one manually viaDeleteTrafficPolicyRequest.builder()
- Parameters:
deleteTrafficPolicyRequest
- AConsumer
that will call methods onDeleteTrafficPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterMemberFromAddressList
default CompletableFuture<DeregisterMemberFromAddressListResponse> deregisterMemberFromAddressList(DeregisterMemberFromAddressListRequest deregisterMemberFromAddressListRequest) Removes a member from an address list.
- Parameters:
deregisterMemberFromAddressListRequest
-- Returns:
- A Java Future containing the result of the DeregisterMemberFromAddressList operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterMemberFromAddressList
default CompletableFuture<DeregisterMemberFromAddressListResponse> deregisterMemberFromAddressList(Consumer<DeregisterMemberFromAddressListRequest.Builder> deregisterMemberFromAddressListRequest) Removes a member from an address list.
This is a convenience which creates an instance of the
DeregisterMemberFromAddressListRequest.Builder
avoiding the need to create one manually viaDeregisterMemberFromAddressListRequest.builder()
- Parameters:
deregisterMemberFromAddressListRequest
- AConsumer
that will call methods onDeregisterMemberFromAddressListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterMemberFromAddressList operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAddonInstance
default CompletableFuture<GetAddonInstanceResponse> getAddonInstance(GetAddonInstanceRequest getAddonInstanceRequest) Gets detailed information about an Add On instance.
- Parameters:
getAddonInstanceRequest
-- Returns:
- A Java Future containing the result of the GetAddonInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAddonInstance
default CompletableFuture<GetAddonInstanceResponse> getAddonInstance(Consumer<GetAddonInstanceRequest.Builder> getAddonInstanceRequest) Gets detailed information about an Add On instance.
This is a convenience which creates an instance of the
GetAddonInstanceRequest.Builder
avoiding the need to create one manually viaGetAddonInstanceRequest.builder()
- Parameters:
getAddonInstanceRequest
- AConsumer
that will call methods onGetAddonInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAddonInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAddonSubscription
default CompletableFuture<GetAddonSubscriptionResponse> getAddonSubscription(GetAddonSubscriptionRequest getAddonSubscriptionRequest) Gets detailed information about an Add On subscription.
- Parameters:
getAddonSubscriptionRequest
-- Returns:
- A Java Future containing the result of the GetAddonSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAddonSubscription
default CompletableFuture<GetAddonSubscriptionResponse> getAddonSubscription(Consumer<GetAddonSubscriptionRequest.Builder> getAddonSubscriptionRequest) Gets detailed information about an Add On subscription.
This is a convenience which creates an instance of the
GetAddonSubscriptionRequest.Builder
avoiding the need to create one manually viaGetAddonSubscriptionRequest.builder()
- Parameters:
getAddonSubscriptionRequest
- AConsumer
that will call methods onGetAddonSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAddonSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAddressList
default CompletableFuture<GetAddressListResponse> getAddressList(GetAddressListRequest getAddressListRequest) Fetch attributes of an address list.
- Parameters:
getAddressListRequest
-- Returns:
- A Java Future containing the result of the GetAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAddressList
default CompletableFuture<GetAddressListResponse> getAddressList(Consumer<GetAddressListRequest.Builder> getAddressListRequest) Fetch attributes of an address list.
This is a convenience which creates an instance of the
GetAddressListRequest.Builder
avoiding the need to create one manually viaGetAddressListRequest.builder()
- Parameters:
getAddressListRequest
- AConsumer
that will call methods onGetAddressListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAddressListImportJob
default CompletableFuture<GetAddressListImportJobResponse> getAddressListImportJob(GetAddressListImportJobRequest getAddressListImportJobRequest) Fetch attributes of an import job.
- Parameters:
getAddressListImportJobRequest
-- Returns:
- A Java Future containing the result of the GetAddressListImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAddressListImportJob
default CompletableFuture<GetAddressListImportJobResponse> getAddressListImportJob(Consumer<GetAddressListImportJobRequest.Builder> getAddressListImportJobRequest) Fetch attributes of an import job.
This is a convenience which creates an instance of the
GetAddressListImportJobRequest.Builder
avoiding the need to create one manually viaGetAddressListImportJobRequest.builder()
- Parameters:
getAddressListImportJobRequest
- AConsumer
that will call methods onGetAddressListImportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAddressListImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchive
Retrieves the full details and current state of a specified email archive.
- Parameters:
getArchiveRequest
- The request to retrieve details of an email archive.- Returns:
- A Java Future containing the result of the GetArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchive
default CompletableFuture<GetArchiveResponse> getArchive(Consumer<GetArchiveRequest.Builder> getArchiveRequest) Retrieves the full details and current state of a specified email archive.
This is a convenience which creates an instance of the
GetArchiveRequest.Builder
avoiding the need to create one manually viaGetArchiveRequest.builder()
- Parameters:
getArchiveRequest
- AConsumer
that will call methods onGetArchiveRequest.Builder
to create a request. The request to retrieve details of an email archive.- Returns:
- A Java Future containing the result of the GetArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveExport
default CompletableFuture<GetArchiveExportResponse> getArchiveExport(GetArchiveExportRequest getArchiveExportRequest) Retrieves the details and current status of a specific email archive export job.
- Parameters:
getArchiveExportRequest
- The request to retrieve details of a specific archive export job.- Returns:
- A Java Future containing the result of the GetArchiveExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveExport
default CompletableFuture<GetArchiveExportResponse> getArchiveExport(Consumer<GetArchiveExportRequest.Builder> getArchiveExportRequest) Retrieves the details and current status of a specific email archive export job.
This is a convenience which creates an instance of the
GetArchiveExportRequest.Builder
avoiding the need to create one manually viaGetArchiveExportRequest.builder()
- Parameters:
getArchiveExportRequest
- AConsumer
that will call methods onGetArchiveExportRequest.Builder
to create a request. The request to retrieve details of a specific archive export job.- Returns:
- A Java Future containing the result of the GetArchiveExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveMessage
default CompletableFuture<GetArchiveMessageResponse> getArchiveMessage(GetArchiveMessageRequest getArchiveMessageRequest) Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
- Parameters:
getArchiveMessageRequest
- The request to get details of a specific email message stored in an archive.- Returns:
- A Java Future containing the result of the GetArchiveMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveMessage
default CompletableFuture<GetArchiveMessageResponse> getArchiveMessage(Consumer<GetArchiveMessageRequest.Builder> getArchiveMessageRequest) Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
This is a convenience which creates an instance of the
GetArchiveMessageRequest.Builder
avoiding the need to create one manually viaGetArchiveMessageRequest.builder()
- Parameters:
getArchiveMessageRequest
- AConsumer
that will call methods onGetArchiveMessageRequest.Builder
to create a request. The request to get details of a specific email message stored in an archive.- Returns:
- A Java Future containing the result of the GetArchiveMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveMessageContent
default CompletableFuture<GetArchiveMessageContentResponse> getArchiveMessageContent(GetArchiveMessageContentRequest getArchiveMessageContentRequest) Returns the textual content of a specific email message stored in the archive. Attachments are not included.
- Parameters:
getArchiveMessageContentRequest
- The request to get the textual content of a specific email message stored in an archive.- Returns:
- A Java Future containing the result of the GetArchiveMessageContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveMessageContent
default CompletableFuture<GetArchiveMessageContentResponse> getArchiveMessageContent(Consumer<GetArchiveMessageContentRequest.Builder> getArchiveMessageContentRequest) Returns the textual content of a specific email message stored in the archive. Attachments are not included.
This is a convenience which creates an instance of the
GetArchiveMessageContentRequest.Builder
avoiding the need to create one manually viaGetArchiveMessageContentRequest.builder()
- Parameters:
getArchiveMessageContentRequest
- AConsumer
that will call methods onGetArchiveMessageContentRequest.Builder
to create a request. The request to get the textual content of a specific email message stored in an archive.- Returns:
- A Java Future containing the result of the GetArchiveMessageContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveSearch
default CompletableFuture<GetArchiveSearchResponse> getArchiveSearch(GetArchiveSearchRequest getArchiveSearchRequest) Retrieves the details and current status of a specific email archive search job.
- Parameters:
getArchiveSearchRequest
- The request to retrieve details of a specific archive search job.- Returns:
- A Java Future containing the result of the GetArchiveSearch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveSearch
default CompletableFuture<GetArchiveSearchResponse> getArchiveSearch(Consumer<GetArchiveSearchRequest.Builder> getArchiveSearchRequest) Retrieves the details and current status of a specific email archive search job.
This is a convenience which creates an instance of the
GetArchiveSearchRequest.Builder
avoiding the need to create one manually viaGetArchiveSearchRequest.builder()
- Parameters:
getArchiveSearchRequest
- AConsumer
that will call methods onGetArchiveSearchRequest.Builder
to create a request. The request to retrieve details of a specific archive search job.- Returns:
- A Java Future containing the result of the GetArchiveSearch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveSearchResults
default CompletableFuture<GetArchiveSearchResultsResponse> getArchiveSearchResults(GetArchiveSearchResultsRequest getArchiveSearchResultsRequest) Returns the results of a completed email archive search job.
- Parameters:
getArchiveSearchResultsRequest
- The request to retrieve results from a completed archive search job.- Returns:
- A Java Future containing the result of the GetArchiveSearchResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArchiveSearchResults
default CompletableFuture<GetArchiveSearchResultsResponse> getArchiveSearchResults(Consumer<GetArchiveSearchResultsRequest.Builder> getArchiveSearchResultsRequest) Returns the results of a completed email archive search job.
This is a convenience which creates an instance of the
GetArchiveSearchResultsRequest.Builder
avoiding the need to create one manually viaGetArchiveSearchResultsRequest.builder()
- Parameters:
getArchiveSearchResultsRequest
- AConsumer
that will call methods onGetArchiveSearchResultsRequest.Builder
to create a request. The request to retrieve results from a completed archive search job.- Returns:
- A Java Future containing the result of the GetArchiveSearchResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIngressPoint
default CompletableFuture<GetIngressPointResponse> getIngressPoint(GetIngressPointRequest getIngressPointRequest) Fetch ingress endpoint resource attributes.
- Parameters:
getIngressPointRequest
-- Returns:
- A Java Future containing the result of the GetIngressPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIngressPoint
default CompletableFuture<GetIngressPointResponse> getIngressPoint(Consumer<GetIngressPointRequest.Builder> getIngressPointRequest) Fetch ingress endpoint resource attributes.
This is a convenience which creates an instance of the
GetIngressPointRequest.Builder
avoiding the need to create one manually viaGetIngressPointRequest.builder()
- Parameters:
getIngressPointRequest
- AConsumer
that will call methods onGetIngressPointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetIngressPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMemberOfAddressList
default CompletableFuture<GetMemberOfAddressListResponse> getMemberOfAddressList(GetMemberOfAddressListRequest getMemberOfAddressListRequest) Fetch attributes of a member in an address list.
- Parameters:
getMemberOfAddressListRequest
-- Returns:
- A Java Future containing the result of the GetMemberOfAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMemberOfAddressList
default CompletableFuture<GetMemberOfAddressListResponse> getMemberOfAddressList(Consumer<GetMemberOfAddressListRequest.Builder> getMemberOfAddressListRequest) Fetch attributes of a member in an address list.
This is a convenience which creates an instance of the
GetMemberOfAddressListRequest.Builder
avoiding the need to create one manually viaGetMemberOfAddressListRequest.builder()
- Parameters:
getMemberOfAddressListRequest
- AConsumer
that will call methods onGetMemberOfAddressListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMemberOfAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRelay
Fetch the relay resource and it's attributes.
- Parameters:
getRelayRequest
-- Returns:
- A Java Future containing the result of the GetRelay operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRelay
default CompletableFuture<GetRelayResponse> getRelay(Consumer<GetRelayRequest.Builder> getRelayRequest) Fetch the relay resource and it's attributes.
This is a convenience which creates an instance of the
GetRelayRequest.Builder
avoiding the need to create one manually viaGetRelayRequest.builder()
- Parameters:
getRelayRequest
- AConsumer
that will call methods onGetRelayRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRelay operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRuleSet
Fetch attributes of a rule set.
- Parameters:
getRuleSetRequest
-- Returns:
- A Java Future containing the result of the GetRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRuleSet
default CompletableFuture<GetRuleSetResponse> getRuleSet(Consumer<GetRuleSetRequest.Builder> getRuleSetRequest) Fetch attributes of a rule set.
This is a convenience which creates an instance of the
GetRuleSetRequest.Builder
avoiding the need to create one manually viaGetRuleSetRequest.builder()
- Parameters:
getRuleSetRequest
- AConsumer
that will call methods onGetRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicy
default CompletableFuture<GetTrafficPolicyResponse> getTrafficPolicy(GetTrafficPolicyRequest getTrafficPolicyRequest) Fetch attributes of a traffic policy resource.
- Parameters:
getTrafficPolicyRequest
-- Returns:
- A Java Future containing the result of the GetTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicy
default CompletableFuture<GetTrafficPolicyResponse> getTrafficPolicy(Consumer<GetTrafficPolicyRequest.Builder> getTrafficPolicyRequest) Fetch attributes of a traffic policy resource.
This is a convenience which creates an instance of the
GetTrafficPolicyRequest.Builder
avoiding the need to create one manually viaGetTrafficPolicyRequest.builder()
- Parameters:
getTrafficPolicyRequest
- AConsumer
that will call methods onGetTrafficPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddonInstances
default CompletableFuture<ListAddonInstancesResponse> listAddonInstances(ListAddonInstancesRequest listAddonInstancesRequest) Lists all Add On instances in your account.
- Parameters:
listAddonInstancesRequest
-- Returns:
- A Java Future containing the result of the ListAddonInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddonInstances
default CompletableFuture<ListAddonInstancesResponse> listAddonInstances(Consumer<ListAddonInstancesRequest.Builder> listAddonInstancesRequest) Lists all Add On instances in your account.
This is a convenience which creates an instance of the
ListAddonInstancesRequest.Builder
avoiding the need to create one manually viaListAddonInstancesRequest.builder()
- Parameters:
listAddonInstancesRequest
- AConsumer
that will call methods onListAddonInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAddonInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddonInstancesPaginator
default ListAddonInstancesPublisher listAddonInstancesPaginator(ListAddonInstancesRequest listAddonInstancesRequest) This is a variant of
listAddonInstances(software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesRequest)
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.mailmanager.paginators.ListAddonInstancesPublisher publisher = client.listAddonInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListAddonInstancesPublisher publisher = client.listAddonInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listAddonInstances(software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesRequest)
operation.- Parameters:
listAddonInstancesRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddonInstancesPaginator
default ListAddonInstancesPublisher listAddonInstancesPaginator(Consumer<ListAddonInstancesRequest.Builder> listAddonInstancesRequest) This is a variant of
listAddonInstances(software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesRequest)
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.mailmanager.paginators.ListAddonInstancesPublisher publisher = client.listAddonInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListAddonInstancesPublisher publisher = client.listAddonInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listAddonInstances(software.amazon.awssdk.services.mailmanager.model.ListAddonInstancesRequest)
operation.
This is a convenience which creates an instance of the
ListAddonInstancesRequest.Builder
avoiding the need to create one manually viaListAddonInstancesRequest.builder()
- Parameters:
listAddonInstancesRequest
- AConsumer
that will call methods onListAddonInstancesRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddonSubscriptions
default CompletableFuture<ListAddonSubscriptionsResponse> listAddonSubscriptions(ListAddonSubscriptionsRequest listAddonSubscriptionsRequest) Lists all Add On subscriptions in your account.
- Parameters:
listAddonSubscriptionsRequest
-- Returns:
- A Java Future containing the result of the ListAddonSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddonSubscriptions
default CompletableFuture<ListAddonSubscriptionsResponse> listAddonSubscriptions(Consumer<ListAddonSubscriptionsRequest.Builder> listAddonSubscriptionsRequest) Lists all Add On subscriptions in your account.
This is a convenience which creates an instance of the
ListAddonSubscriptionsRequest.Builder
avoiding the need to create one manually viaListAddonSubscriptionsRequest.builder()
- Parameters:
listAddonSubscriptionsRequest
- AConsumer
that will call methods onListAddonSubscriptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAddonSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddonSubscriptionsPaginator
default ListAddonSubscriptionsPublisher listAddonSubscriptionsPaginator(ListAddonSubscriptionsRequest listAddonSubscriptionsRequest) This is a variant of
listAddonSubscriptions(software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsRequest)
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.mailmanager.paginators.ListAddonSubscriptionsPublisher publisher = client.listAddonSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListAddonSubscriptionsPublisher publisher = client.listAddonSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listAddonSubscriptions(software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsRequest)
operation.- Parameters:
listAddonSubscriptionsRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddonSubscriptionsPaginator
default ListAddonSubscriptionsPublisher listAddonSubscriptionsPaginator(Consumer<ListAddonSubscriptionsRequest.Builder> listAddonSubscriptionsRequest) This is a variant of
listAddonSubscriptions(software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsRequest)
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.mailmanager.paginators.ListAddonSubscriptionsPublisher publisher = client.listAddonSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListAddonSubscriptionsPublisher publisher = client.listAddonSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listAddonSubscriptions(software.amazon.awssdk.services.mailmanager.model.ListAddonSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
ListAddonSubscriptionsRequest.Builder
avoiding the need to create one manually viaListAddonSubscriptionsRequest.builder()
- Parameters:
listAddonSubscriptionsRequest
- AConsumer
that will call methods onListAddonSubscriptionsRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddressListImportJobs
default CompletableFuture<ListAddressListImportJobsResponse> listAddressListImportJobs(ListAddressListImportJobsRequest listAddressListImportJobsRequest) Lists jobs for an address list.
- Parameters:
listAddressListImportJobsRequest
-- Returns:
- A Java Future containing the result of the ListAddressListImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddressListImportJobs
default CompletableFuture<ListAddressListImportJobsResponse> listAddressListImportJobs(Consumer<ListAddressListImportJobsRequest.Builder> listAddressListImportJobsRequest) Lists jobs for an address list.
This is a convenience which creates an instance of the
ListAddressListImportJobsRequest.Builder
avoiding the need to create one manually viaListAddressListImportJobsRequest.builder()
- Parameters:
listAddressListImportJobsRequest
- AConsumer
that will call methods onListAddressListImportJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAddressListImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddressListImportJobsPaginator
default ListAddressListImportJobsPublisher listAddressListImportJobsPaginator(ListAddressListImportJobsRequest listAddressListImportJobsRequest) This is a variant of
listAddressListImportJobs(software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsRequest)
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.mailmanager.paginators.ListAddressListImportJobsPublisher publisher = client.listAddressListImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListAddressListImportJobsPublisher publisher = client.listAddressListImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listAddressListImportJobs(software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsRequest)
operation.- Parameters:
listAddressListImportJobsRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddressListImportJobsPaginator
default ListAddressListImportJobsPublisher listAddressListImportJobsPaginator(Consumer<ListAddressListImportJobsRequest.Builder> listAddressListImportJobsRequest) This is a variant of
listAddressListImportJobs(software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsRequest)
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.mailmanager.paginators.ListAddressListImportJobsPublisher publisher = client.listAddressListImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListAddressListImportJobsPublisher publisher = client.listAddressListImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listAddressListImportJobs(software.amazon.awssdk.services.mailmanager.model.ListAddressListImportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListAddressListImportJobsRequest.Builder
avoiding the need to create one manually viaListAddressListImportJobsRequest.builder()
- Parameters:
listAddressListImportJobsRequest
- AConsumer
that will call methods onListAddressListImportJobsRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddressLists
default CompletableFuture<ListAddressListsResponse> listAddressLists(ListAddressListsRequest listAddressListsRequest) Lists address lists for this account.
- Parameters:
listAddressListsRequest
-- Returns:
- A Java Future containing the result of the ListAddressLists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddressLists
default CompletableFuture<ListAddressListsResponse> listAddressLists(Consumer<ListAddressListsRequest.Builder> listAddressListsRequest) Lists address lists for this account.
This is a convenience which creates an instance of the
ListAddressListsRequest.Builder
avoiding the need to create one manually viaListAddressListsRequest.builder()
- Parameters:
listAddressListsRequest
- AConsumer
that will call methods onListAddressListsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAddressLists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddressListsPaginator
default ListAddressListsPublisher listAddressListsPaginator(ListAddressListsRequest listAddressListsRequest) This is a variant of
listAddressLists(software.amazon.awssdk.services.mailmanager.model.ListAddressListsRequest)
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.mailmanager.paginators.ListAddressListsPublisher publisher = client.listAddressListsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListAddressListsPublisher publisher = client.listAddressListsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListAddressListsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListAddressListsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listAddressLists(software.amazon.awssdk.services.mailmanager.model.ListAddressListsRequest)
operation.- Parameters:
listAddressListsRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAddressListsPaginator
default ListAddressListsPublisher listAddressListsPaginator(Consumer<ListAddressListsRequest.Builder> listAddressListsRequest) This is a variant of
listAddressLists(software.amazon.awssdk.services.mailmanager.model.ListAddressListsRequest)
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.mailmanager.paginators.ListAddressListsPublisher publisher = client.listAddressListsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListAddressListsPublisher publisher = client.listAddressListsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListAddressListsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListAddressListsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listAddressLists(software.amazon.awssdk.services.mailmanager.model.ListAddressListsRequest)
operation.
This is a convenience which creates an instance of the
ListAddressListsRequest.Builder
avoiding the need to create one manually viaListAddressListsRequest.builder()
- Parameters:
listAddressListsRequest
- AConsumer
that will call methods onListAddressListsRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveExports
default CompletableFuture<ListArchiveExportsResponse> listArchiveExports(ListArchiveExportsRequest listArchiveExportsRequest) Returns a list of email archive export jobs.
- Parameters:
listArchiveExportsRequest
- The request to list archive export jobs in your account.- Returns:
- A Java Future containing the result of the ListArchiveExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveExports
default CompletableFuture<ListArchiveExportsResponse> listArchiveExports(Consumer<ListArchiveExportsRequest.Builder> listArchiveExportsRequest) Returns a list of email archive export jobs.
This is a convenience which creates an instance of the
ListArchiveExportsRequest.Builder
avoiding the need to create one manually viaListArchiveExportsRequest.builder()
- Parameters:
listArchiveExportsRequest
- AConsumer
that will call methods onListArchiveExportsRequest.Builder
to create a request. The request to list archive export jobs in your account.- Returns:
- A Java Future containing the result of the ListArchiveExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveExportsPaginator
default ListArchiveExportsPublisher listArchiveExportsPaginator(ListArchiveExportsRequest listArchiveExportsRequest) This is a variant of
listArchiveExports(software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsRequest)
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.mailmanager.paginators.ListArchiveExportsPublisher publisher = client.listArchiveExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListArchiveExportsPublisher publisher = client.listArchiveExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listArchiveExports(software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsRequest)
operation.- Parameters:
listArchiveExportsRequest
- The request to list archive export jobs in your account.- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveExportsPaginator
default ListArchiveExportsPublisher listArchiveExportsPaginator(Consumer<ListArchiveExportsRequest.Builder> listArchiveExportsRequest) This is a variant of
listArchiveExports(software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsRequest)
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.mailmanager.paginators.ListArchiveExportsPublisher publisher = client.listArchiveExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListArchiveExportsPublisher publisher = client.listArchiveExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listArchiveExports(software.amazon.awssdk.services.mailmanager.model.ListArchiveExportsRequest)
operation.
This is a convenience which creates an instance of the
ListArchiveExportsRequest.Builder
avoiding the need to create one manually viaListArchiveExportsRequest.builder()
- Parameters:
listArchiveExportsRequest
- AConsumer
that will call methods onListArchiveExportsRequest.Builder
to create a request. The request to list archive export jobs in your account.- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveSearches
default CompletableFuture<ListArchiveSearchesResponse> listArchiveSearches(ListArchiveSearchesRequest listArchiveSearchesRequest) Returns a list of email archive search jobs.
- Parameters:
listArchiveSearchesRequest
- The request to list archive search jobs in your account.- Returns:
- A Java Future containing the result of the ListArchiveSearches operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveSearches
default CompletableFuture<ListArchiveSearchesResponse> listArchiveSearches(Consumer<ListArchiveSearchesRequest.Builder> listArchiveSearchesRequest) Returns a list of email archive search jobs.
This is a convenience which creates an instance of the
ListArchiveSearchesRequest.Builder
avoiding the need to create one manually viaListArchiveSearchesRequest.builder()
- Parameters:
listArchiveSearchesRequest
- AConsumer
that will call methods onListArchiveSearchesRequest.Builder
to create a request. The request to list archive search jobs in your account.- Returns:
- A Java Future containing the result of the ListArchiveSearches operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveSearchesPaginator
default ListArchiveSearchesPublisher listArchiveSearchesPaginator(ListArchiveSearchesRequest listArchiveSearchesRequest) This is a variant of
listArchiveSearches(software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesRequest)
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.mailmanager.paginators.ListArchiveSearchesPublisher publisher = client.listArchiveSearchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListArchiveSearchesPublisher publisher = client.listArchiveSearchesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listArchiveSearches(software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesRequest)
operation.- Parameters:
listArchiveSearchesRequest
- The request to list archive search jobs in your account.- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchiveSearchesPaginator
default ListArchiveSearchesPublisher listArchiveSearchesPaginator(Consumer<ListArchiveSearchesRequest.Builder> listArchiveSearchesRequest) This is a variant of
listArchiveSearches(software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesRequest)
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.mailmanager.paginators.ListArchiveSearchesPublisher publisher = client.listArchiveSearchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListArchiveSearchesPublisher publisher = client.listArchiveSearchesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listArchiveSearches(software.amazon.awssdk.services.mailmanager.model.ListArchiveSearchesRequest)
operation.
This is a convenience which creates an instance of the
ListArchiveSearchesRequest.Builder
avoiding the need to create one manually viaListArchiveSearchesRequest.builder()
- Parameters:
listArchiveSearchesRequest
- AConsumer
that will call methods onListArchiveSearchesRequest.Builder
to create a request. The request to list archive search jobs in your account.- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchives
default CompletableFuture<ListArchivesResponse> listArchives(ListArchivesRequest listArchivesRequest) Returns a list of all email archives in your account.
- Parameters:
listArchivesRequest
- The request to list email archives in your account.- Returns:
- A Java Future containing the result of the ListArchives operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchives
default CompletableFuture<ListArchivesResponse> listArchives(Consumer<ListArchivesRequest.Builder> listArchivesRequest) Returns a list of all email archives in your account.
This is a convenience which creates an instance of the
ListArchivesRequest.Builder
avoiding the need to create one manually viaListArchivesRequest.builder()
- Parameters:
listArchivesRequest
- AConsumer
that will call methods onListArchivesRequest.Builder
to create a request. The request to list email archives in your account.- Returns:
- A Java Future containing the result of the ListArchives operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchivesPaginator
This is a variant of
listArchives(software.amazon.awssdk.services.mailmanager.model.ListArchivesRequest)
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.mailmanager.paginators.ListArchivesPublisher publisher = client.listArchivesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListArchivesPublisher publisher = client.listArchivesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListArchivesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListArchivesResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listArchives(software.amazon.awssdk.services.mailmanager.model.ListArchivesRequest)
operation.- Parameters:
listArchivesRequest
- The request to list email archives in your account.- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArchivesPaginator
default ListArchivesPublisher listArchivesPaginator(Consumer<ListArchivesRequest.Builder> listArchivesRequest) This is a variant of
listArchives(software.amazon.awssdk.services.mailmanager.model.ListArchivesRequest)
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.mailmanager.paginators.ListArchivesPublisher publisher = client.listArchivesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListArchivesPublisher publisher = client.listArchivesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListArchivesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListArchivesResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listArchives(software.amazon.awssdk.services.mailmanager.model.ListArchivesRequest)
operation.
This is a convenience which creates an instance of the
ListArchivesRequest.Builder
avoiding the need to create one manually viaListArchivesRequest.builder()
- Parameters:
listArchivesRequest
- AConsumer
that will call methods onListArchivesRequest.Builder
to create a request. The request to list email archives in your account.- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIngressPoints
default CompletableFuture<ListIngressPointsResponse> listIngressPoints(ListIngressPointsRequest listIngressPointsRequest) List all ingress endpoint resources.
- Parameters:
listIngressPointsRequest
-- Returns:
- A Java Future containing the result of the ListIngressPoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIngressPoints
default CompletableFuture<ListIngressPointsResponse> listIngressPoints(Consumer<ListIngressPointsRequest.Builder> listIngressPointsRequest) List all ingress endpoint resources.
This is a convenience which creates an instance of the
ListIngressPointsRequest.Builder
avoiding the need to create one manually viaListIngressPointsRequest.builder()
- Parameters:
listIngressPointsRequest
- AConsumer
that will call methods onListIngressPointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListIngressPoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIngressPointsPaginator
default ListIngressPointsPublisher listIngressPointsPaginator(ListIngressPointsRequest listIngressPointsRequest) This is a variant of
listIngressPoints(software.amazon.awssdk.services.mailmanager.model.ListIngressPointsRequest)
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.mailmanager.paginators.ListIngressPointsPublisher publisher = client.listIngressPointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListIngressPointsPublisher publisher = client.listIngressPointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListIngressPointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListIngressPointsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listIngressPoints(software.amazon.awssdk.services.mailmanager.model.ListIngressPointsRequest)
operation.- Parameters:
listIngressPointsRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIngressPointsPaginator
default ListIngressPointsPublisher listIngressPointsPaginator(Consumer<ListIngressPointsRequest.Builder> listIngressPointsRequest) This is a variant of
listIngressPoints(software.amazon.awssdk.services.mailmanager.model.ListIngressPointsRequest)
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.mailmanager.paginators.ListIngressPointsPublisher publisher = client.listIngressPointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListIngressPointsPublisher publisher = client.listIngressPointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListIngressPointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListIngressPointsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listIngressPoints(software.amazon.awssdk.services.mailmanager.model.ListIngressPointsRequest)
operation.
This is a convenience which creates an instance of the
ListIngressPointsRequest.Builder
avoiding the need to create one manually viaListIngressPointsRequest.builder()
- Parameters:
listIngressPointsRequest
- AConsumer
that will call methods onListIngressPointsRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembersOfAddressList
default CompletableFuture<ListMembersOfAddressListResponse> listMembersOfAddressList(ListMembersOfAddressListRequest listMembersOfAddressListRequest) Lists members of an address list.
- Parameters:
listMembersOfAddressListRequest
-- Returns:
- A Java Future containing the result of the ListMembersOfAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembersOfAddressList
default CompletableFuture<ListMembersOfAddressListResponse> listMembersOfAddressList(Consumer<ListMembersOfAddressListRequest.Builder> listMembersOfAddressListRequest) Lists members of an address list.
This is a convenience which creates an instance of the
ListMembersOfAddressListRequest.Builder
avoiding the need to create one manually viaListMembersOfAddressListRequest.builder()
- Parameters:
listMembersOfAddressListRequest
- AConsumer
that will call methods onListMembersOfAddressListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMembersOfAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembersOfAddressListPaginator
default ListMembersOfAddressListPublisher listMembersOfAddressListPaginator(ListMembersOfAddressListRequest listMembersOfAddressListRequest) This is a variant of
listMembersOfAddressList(software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListRequest)
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.mailmanager.paginators.ListMembersOfAddressListPublisher publisher = client.listMembersOfAddressListPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListMembersOfAddressListPublisher publisher = client.listMembersOfAddressListPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listMembersOfAddressList(software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListRequest)
operation.- Parameters:
listMembersOfAddressListRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembersOfAddressListPaginator
default ListMembersOfAddressListPublisher listMembersOfAddressListPaginator(Consumer<ListMembersOfAddressListRequest.Builder> listMembersOfAddressListRequest) This is a variant of
listMembersOfAddressList(software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListRequest)
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.mailmanager.paginators.ListMembersOfAddressListPublisher publisher = client.listMembersOfAddressListPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListMembersOfAddressListPublisher publisher = client.listMembersOfAddressListPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listMembersOfAddressList(software.amazon.awssdk.services.mailmanager.model.ListMembersOfAddressListRequest)
operation.
This is a convenience which creates an instance of the
ListMembersOfAddressListRequest.Builder
avoiding the need to create one manually viaListMembersOfAddressListRequest.builder()
- Parameters:
listMembersOfAddressListRequest
- AConsumer
that will call methods onListMembersOfAddressListRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelays
Lists all the existing relay resources.
- Parameters:
listRelaysRequest
-- Returns:
- A Java Future containing the result of the ListRelays operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelays
default CompletableFuture<ListRelaysResponse> listRelays(Consumer<ListRelaysRequest.Builder> listRelaysRequest) Lists all the existing relay resources.
This is a convenience which creates an instance of the
ListRelaysRequest.Builder
avoiding the need to create one manually viaListRelaysRequest.builder()
- Parameters:
listRelaysRequest
- AConsumer
that will call methods onListRelaysRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRelays operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelaysPaginator
This is a variant of
listRelays(software.amazon.awssdk.services.mailmanager.model.ListRelaysRequest)
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.mailmanager.paginators.ListRelaysPublisher publisher = client.listRelaysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListRelaysPublisher publisher = client.listRelaysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListRelaysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListRelaysResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listRelays(software.amazon.awssdk.services.mailmanager.model.ListRelaysRequest)
operation.- Parameters:
listRelaysRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelaysPaginator
default ListRelaysPublisher listRelaysPaginator(Consumer<ListRelaysRequest.Builder> listRelaysRequest) This is a variant of
listRelays(software.amazon.awssdk.services.mailmanager.model.ListRelaysRequest)
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.mailmanager.paginators.ListRelaysPublisher publisher = client.listRelaysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListRelaysPublisher publisher = client.listRelaysPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListRelaysResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListRelaysResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listRelays(software.amazon.awssdk.services.mailmanager.model.ListRelaysRequest)
operation.
This is a convenience which creates an instance of the
ListRelaysRequest.Builder
avoiding the need to create one manually viaListRelaysRequest.builder()
- Parameters:
listRelaysRequest
- AConsumer
that will call methods onListRelaysRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleSets
default CompletableFuture<ListRuleSetsResponse> listRuleSets(ListRuleSetsRequest listRuleSetsRequest) List rule sets for this account.
- Parameters:
listRuleSetsRequest
-- Returns:
- A Java Future containing the result of the ListRuleSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleSets
default CompletableFuture<ListRuleSetsResponse> listRuleSets(Consumer<ListRuleSetsRequest.Builder> listRuleSetsRequest) List rule sets for this account.
This is a convenience which creates an instance of the
ListRuleSetsRequest.Builder
avoiding the need to create one manually viaListRuleSetsRequest.builder()
- Parameters:
listRuleSetsRequest
- AConsumer
that will call methods onListRuleSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRuleSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleSetsPaginator
This is a variant of
listRuleSets(software.amazon.awssdk.services.mailmanager.model.ListRuleSetsRequest)
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.mailmanager.paginators.ListRuleSetsPublisher publisher = client.listRuleSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListRuleSetsPublisher publisher = client.listRuleSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListRuleSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListRuleSetsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listRuleSets(software.amazon.awssdk.services.mailmanager.model.ListRuleSetsRequest)
operation.- Parameters:
listRuleSetsRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleSetsPaginator
default ListRuleSetsPublisher listRuleSetsPaginator(Consumer<ListRuleSetsRequest.Builder> listRuleSetsRequest) This is a variant of
listRuleSets(software.amazon.awssdk.services.mailmanager.model.ListRuleSetsRequest)
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.mailmanager.paginators.ListRuleSetsPublisher publisher = client.listRuleSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListRuleSetsPublisher publisher = client.listRuleSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListRuleSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListRuleSetsResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listRuleSets(software.amazon.awssdk.services.mailmanager.model.ListRuleSetsRequest)
operation.
This is a convenience which creates an instance of the
ListRuleSetsRequest.Builder
avoiding the need to create one manually viaListRuleSetsRequest.builder()
- Parameters:
listRuleSetsRequest
- AConsumer
that will call methods onListRuleSetsRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of tags (keys and values) assigned to the resource.
- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the list of tags (keys and values) assigned to the resource.
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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicies
default CompletableFuture<ListTrafficPoliciesResponse> listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest) List traffic policy resources.
- Parameters:
listTrafficPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListTrafficPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicies
default CompletableFuture<ListTrafficPoliciesResponse> listTrafficPolicies(Consumer<ListTrafficPoliciesRequest.Builder> listTrafficPoliciesRequest) List traffic policy resources.
This is a convenience which creates an instance of the
ListTrafficPoliciesRequest.Builder
avoiding the need to create one manually viaListTrafficPoliciesRequest.builder()
- Parameters:
listTrafficPoliciesRequest
- AConsumer
that will call methods onListTrafficPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTrafficPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPoliciesPaginator
default ListTrafficPoliciesPublisher listTrafficPoliciesPaginator(ListTrafficPoliciesRequest listTrafficPoliciesRequest) This is a variant of
listTrafficPolicies(software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesRequest)
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.mailmanager.paginators.ListTrafficPoliciesPublisher publisher = client.listTrafficPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListTrafficPoliciesPublisher publisher = client.listTrafficPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listTrafficPolicies(software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesRequest)
operation.- Parameters:
listTrafficPoliciesRequest
-- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPoliciesPaginator
default ListTrafficPoliciesPublisher listTrafficPoliciesPaginator(Consumer<ListTrafficPoliciesRequest.Builder> listTrafficPoliciesRequest) This is a variant of
listTrafficPolicies(software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesRequest)
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.mailmanager.paginators.ListTrafficPoliciesPublisher publisher = client.listTrafficPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mailmanager.paginators.ListTrafficPoliciesPublisher publisher = client.listTrafficPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesResponse response) { //... }; });
Please notice that the configuration of PageSize 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
listTrafficPolicies(software.amazon.awssdk.services.mailmanager.model.ListTrafficPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListTrafficPoliciesRequest.Builder
avoiding the need to create one manually viaListTrafficPoliciesRequest.builder()
- Parameters:
listTrafficPoliciesRequest
- AConsumer
that will call methods onListTrafficPoliciesRequest.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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerMemberToAddressList
default CompletableFuture<RegisterMemberToAddressListResponse> registerMemberToAddressList(RegisterMemberToAddressListRequest registerMemberToAddressListRequest) Adds a member to an address list.
- Parameters:
registerMemberToAddressListRequest
-- Returns:
- A Java Future containing the result of the RegisterMemberToAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerMemberToAddressList
default CompletableFuture<RegisterMemberToAddressListResponse> registerMemberToAddressList(Consumer<RegisterMemberToAddressListRequest.Builder> registerMemberToAddressListRequest) Adds a member to an address list.
This is a convenience which creates an instance of the
RegisterMemberToAddressListRequest.Builder
avoiding the need to create one manually viaRegisterMemberToAddressListRequest.builder()
- Parameters:
registerMemberToAddressListRequest
- AConsumer
that will call methods onRegisterMemberToAddressListRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterMemberToAddressList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAddressListImportJob
default CompletableFuture<StartAddressListImportJobResponse> startAddressListImportJob(StartAddressListImportJobRequest startAddressListImportJobRequest) Starts an import job for an address list.
- Parameters:
startAddressListImportJobRequest
-- Returns:
- A Java Future containing the result of the StartAddressListImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAddressListImportJob
default CompletableFuture<StartAddressListImportJobResponse> startAddressListImportJob(Consumer<StartAddressListImportJobRequest.Builder> startAddressListImportJobRequest) Starts an import job for an address list.
This is a convenience which creates an instance of the
StartAddressListImportJobRequest.Builder
avoiding the need to create one manually viaStartAddressListImportJobRequest.builder()
- Parameters:
startAddressListImportJobRequest
- AConsumer
that will call methods onStartAddressListImportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartAddressListImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startArchiveExport
default CompletableFuture<StartArchiveExportResponse> startArchiveExport(StartArchiveExportRequest startArchiveExportRequest) Initiates an export of emails from the specified archive.
- Parameters:
startArchiveExportRequest
- The request to initiate an export of emails from an archive.- Returns:
- A Java Future containing the result of the StartArchiveExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startArchiveExport
default CompletableFuture<StartArchiveExportResponse> startArchiveExport(Consumer<StartArchiveExportRequest.Builder> startArchiveExportRequest) Initiates an export of emails from the specified archive.
This is a convenience which creates an instance of the
StartArchiveExportRequest.Builder
avoiding the need to create one manually viaStartArchiveExportRequest.builder()
- Parameters:
startArchiveExportRequest
- AConsumer
that will call methods onStartArchiveExportRequest.Builder
to create a request. The request to initiate an export of emails from an archive.- Returns:
- A Java Future containing the result of the StartArchiveExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startArchiveSearch
default CompletableFuture<StartArchiveSearchResponse> startArchiveSearch(StartArchiveSearchRequest startArchiveSearchRequest) Initiates a search across emails in the specified archive.
- Parameters:
startArchiveSearchRequest
- The request to initiate a search across emails in an archive.- Returns:
- A Java Future containing the result of the StartArchiveSearch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startArchiveSearch
default CompletableFuture<StartArchiveSearchResponse> startArchiveSearch(Consumer<StartArchiveSearchRequest.Builder> startArchiveSearchRequest) Initiates a search across emails in the specified archive.
This is a convenience which creates an instance of the
StartArchiveSearchRequest.Builder
avoiding the need to create one manually viaStartArchiveSearchRequest.builder()
- Parameters:
startArchiveSearchRequest
- AConsumer
that will call methods onStartArchiveSearchRequest.Builder
to create a request. The request to initiate a search across emails in an archive.- Returns:
- A Java Future containing the result of the StartArchiveSearch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopAddressListImportJob
default CompletableFuture<StopAddressListImportJobResponse> stopAddressListImportJob(StopAddressListImportJobRequest stopAddressListImportJobRequest) Stops an ongoing import job for an address list.
- Parameters:
stopAddressListImportJobRequest
-- Returns:
- A Java Future containing the result of the StopAddressListImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopAddressListImportJob
default CompletableFuture<StopAddressListImportJobResponse> stopAddressListImportJob(Consumer<StopAddressListImportJobRequest.Builder> stopAddressListImportJobRequest) Stops an ongoing import job for an address list.
This is a convenience which creates an instance of the
StopAddressListImportJobRequest.Builder
avoiding the need to create one manually viaStopAddressListImportJobRequest.builder()
- Parameters:
stopAddressListImportJobRequest
- AConsumer
that will call methods onStopAddressListImportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopAddressListImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopArchiveExport
default CompletableFuture<StopArchiveExportResponse> stopArchiveExport(StopArchiveExportRequest stopArchiveExportRequest) Stops an in-progress export of emails from an archive.
- Parameters:
stopArchiveExportRequest
- The request to stop an in-progress archive export job.- Returns:
- A Java Future containing the result of the StopArchiveExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopArchiveExport
default CompletableFuture<StopArchiveExportResponse> stopArchiveExport(Consumer<StopArchiveExportRequest.Builder> stopArchiveExportRequest) Stops an in-progress export of emails from an archive.
This is a convenience which creates an instance of the
StopArchiveExportRequest.Builder
avoiding the need to create one manually viaStopArchiveExportRequest.builder()
- Parameters:
stopArchiveExportRequest
- AConsumer
that will call methods onStopArchiveExportRequest.Builder
to create a request. The request to stop an in-progress archive export job.- Returns:
- A Java Future containing the result of the StopArchiveExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopArchiveSearch
default CompletableFuture<StopArchiveSearchResponse> stopArchiveSearch(StopArchiveSearchRequest stopArchiveSearchRequest) Stops an in-progress archive search job.
- Parameters:
stopArchiveSearchRequest
- The request to stop an in-progress archive search job.- Returns:
- A Java Future containing the result of the StopArchiveSearch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopArchiveSearch
default CompletableFuture<StopArchiveSearchResponse> stopArchiveSearch(Consumer<StopArchiveSearchRequest.Builder> stopArchiveSearchRequest) Stops an in-progress archive search job.
This is a convenience which creates an instance of the
StopArchiveSearchRequest.Builder
avoiding the need to create one manually viaStopArchiveSearchRequest.builder()
- Parameters:
stopArchiveSearchRequest
- AConsumer
that will call methods onStopArchiveSearchRequest.Builder
to create a request. The request to stop an in-progress archive search job.- Returns:
- A Java Future containing the result of the StopArchiveSearch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds one or more tags (keys and values) to a specified resource.
- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags (keys and values) to a specified resource.
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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.
- 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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.
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.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateArchive
default CompletableFuture<UpdateArchiveResponse> updateArchive(UpdateArchiveRequest updateArchiveRequest) Updates the attributes of an existing email archive.
- Parameters:
updateArchiveRequest
- The request to update properties of an existing email archive.- Returns:
- A Java Future containing the result of the UpdateArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateArchive
default CompletableFuture<UpdateArchiveResponse> updateArchive(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest) Updates the attributes of an existing email archive.
This is a convenience which creates an instance of the
UpdateArchiveRequest.Builder
avoiding the need to create one manually viaUpdateArchiveRequest.builder()
- Parameters:
updateArchiveRequest
- AConsumer
that will call methods onUpdateArchiveRequest.Builder
to create a request. The request to update properties of an existing email archive.- Returns:
- A Java Future containing the result of the UpdateArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- AccessDeniedException Occurs when a user is denied access to a specific resource or action.
- ServiceQuotaExceededException Occurs when an operation exceeds a predefined service quota or limit.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- ThrottlingException Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIngressPoint
default CompletableFuture<UpdateIngressPointResponse> updateIngressPoint(UpdateIngressPointRequest updateIngressPointRequest) Update attributes of a provisioned ingress endpoint resource.
- Parameters:
updateIngressPointRequest
-- Returns:
- A Java Future containing the result of the UpdateIngressPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIngressPoint
default CompletableFuture<UpdateIngressPointResponse> updateIngressPoint(Consumer<UpdateIngressPointRequest.Builder> updateIngressPointRequest) Update attributes of a provisioned ingress endpoint resource.
This is a convenience which creates an instance of the
UpdateIngressPointRequest.Builder
avoiding the need to create one manually viaUpdateIngressPointRequest.builder()
- Parameters:
updateIngressPointRequest
- AConsumer
that will call methods onUpdateIngressPointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateIngressPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRelay
Updates the attributes of an existing relay resource.
- Parameters:
updateRelayRequest
-- Returns:
- A Java Future containing the result of the UpdateRelay operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRelay
default CompletableFuture<UpdateRelayResponse> updateRelay(Consumer<UpdateRelayRequest.Builder> updateRelayRequest) Updates the attributes of an existing relay resource.
This is a convenience which creates an instance of the
UpdateRelayRequest.Builder
avoiding the need to create one manually viaUpdateRelayRequest.builder()
- Parameters:
updateRelayRequest
- AConsumer
that will call methods onUpdateRelayRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRelay operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRuleSet
default CompletableFuture<UpdateRuleSetResponse> updateRuleSet(UpdateRuleSetRequest updateRuleSetRequest) Update attributes of an already provisioned rule set.
- Parameters:
updateRuleSetRequest
-- Returns:
- A Java Future containing the result of the UpdateRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRuleSet
default CompletableFuture<UpdateRuleSetResponse> updateRuleSet(Consumer<UpdateRuleSetRequest.Builder> updateRuleSetRequest) Update attributes of an already provisioned rule set.
This is a convenience which creates an instance of the
UpdateRuleSetRequest.Builder
avoiding the need to create one manually viaUpdateRuleSetRequest.builder()
- Parameters:
updateRuleSetRequest
- AConsumer
that will call methods onUpdateRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrafficPolicy
default CompletableFuture<UpdateTrafficPolicyResponse> updateTrafficPolicy(UpdateTrafficPolicyRequest updateTrafficPolicyRequest) Update attributes of an already provisioned traffic policy resource.
- Parameters:
updateTrafficPolicyRequest
-- Returns:
- A Java Future containing the result of the UpdateTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrafficPolicy
default CompletableFuture<UpdateTrafficPolicyResponse> updateTrafficPolicy(Consumer<UpdateTrafficPolicyRequest.Builder> updateTrafficPolicyRequest) Update attributes of an already provisioned traffic policy resource.
This is a convenience which creates an instance of the
UpdateTrafficPolicyRequest.Builder
avoiding the need to create one manually viaUpdateTrafficPolicyRequest.builder()
- Parameters:
updateTrafficPolicyRequest
- AConsumer
that will call methods onUpdateTrafficPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request validation has failed. For details, see the accompanying error message.
- ConflictException The request configuration has conflicts. For details, see the accompanying error message.
- ResourceNotFoundException Occurs when a requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MailManagerException 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 aMailManagerAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMailManagerAsyncClient
.
-