Interface MailManagerAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MailManagerAsyncClient extends AwsClient
Service client for accessing MailManager asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported 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.AWS SES Mail Manager API AWS SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service.
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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateAddonInstanceRequest.builder()- Parameters:
createAddonInstanceRequest- AConsumerthat will call methods onCreateAddonInstanceRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateAddonSubscriptionRequest.builder()- Parameters:
createAddonSubscriptionRequest- AConsumerthat will call methods onCreateAddonSubscriptionRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateArchiveRequest.builder()- Parameters:
createArchiveRequest- AConsumerthat will call methods onCreateArchiveRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateIngressPointRequest.builder()- Parameters:
createIngressPointRequest- AConsumerthat will call methods onCreateIngressPointRequest.Builderto 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:
- AWS API Documentation
-
createRelay
default CompletableFuture<CreateRelayResponse> createRelay(CreateRelayRequest createRelayRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateRelayRequest.builder()- Parameters:
createRelayRequest- AConsumerthat will call methods onCreateRelayRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateRuleSetRequest.builder()- Parameters:
createRuleSetRequest- AConsumerthat will call methods onCreateRuleSetRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateTrafficPolicyRequest.builder()- Parameters:
createTrafficPolicyRequest- AConsumerthat will call methods onCreateTrafficPolicyRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAddonInstanceRequest.builder()- Parameters:
deleteAddonInstanceRequest- AConsumerthat will call methods onDeleteAddonInstanceRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAddonSubscriptionRequest.builder()- Parameters:
deleteAddonSubscriptionRequest- AConsumerthat will call methods onDeleteAddonSubscriptionRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteArchiveRequest.builder()- Parameters:
deleteArchiveRequest- AConsumerthat will call methods onDeleteArchiveRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteIngressPointRequest.builder()- Parameters:
deleteIngressPointRequest- AConsumerthat will call methods onDeleteIngressPointRequest.Builderto 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:
- AWS API Documentation
-
deleteRelay
default CompletableFuture<DeleteRelayResponse> deleteRelay(DeleteRelayRequest deleteRelayRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteRelayRequest.builder()- Parameters:
deleteRelayRequest- AConsumerthat will call methods onDeleteRelayRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
deleteRuleSet
default CompletableFuture<DeleteRuleSetResponse> deleteRuleSet(Consumer<DeleteRuleSetRequest.Builder> deleteRuleSetRequest)
Delete a rule set.
This is a convenience which creates an instance of the
DeleteRuleSetRequest.Builderavoiding the need to create one manually viaDeleteRuleSetRequest.builder()- Parameters:
deleteRuleSetRequest- AConsumerthat will call methods onDeleteRuleSetRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteTrafficPolicyRequest.builder()- Parameters:
deleteTrafficPolicyRequest- AConsumerthat will call methods onDeleteTrafficPolicyRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetAddonInstanceRequest.builder()- Parameters:
getAddonInstanceRequest- AConsumerthat will call methods onGetAddonInstanceRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetAddonSubscriptionRequest.builder()- Parameters:
getAddonSubscriptionRequest- AConsumerthat will call methods onGetAddonSubscriptionRequest.Builderto 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:
- AWS API Documentation
-
getArchive
default CompletableFuture<GetArchiveResponse> getArchive(GetArchiveRequest getArchiveRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetArchiveRequest.builder()- Parameters:
getArchiveRequest- AConsumerthat will call methods onGetArchiveRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetArchiveExportRequest.builder()- Parameters:
getArchiveExportRequest- AConsumerthat will call methods onGetArchiveExportRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetArchiveMessageRequest.builder()- Parameters:
getArchiveMessageRequest- AConsumerthat will call methods onGetArchiveMessageRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetArchiveMessageContentRequest.builder()- Parameters:
getArchiveMessageContentRequest- AConsumerthat will call methods onGetArchiveMessageContentRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetArchiveSearchRequest.builder()- Parameters:
getArchiveSearchRequest- AConsumerthat will call methods onGetArchiveSearchRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetArchiveSearchResultsRequest.builder()- Parameters:
getArchiveSearchResultsRequest- AConsumerthat will call methods onGetArchiveSearchResultsRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetIngressPointRequest.builder()- Parameters:
getIngressPointRequest- AConsumerthat will call methods onGetIngressPointRequest.Builderto 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:
- AWS API Documentation
-
getRelay
default CompletableFuture<GetRelayResponse> getRelay(GetRelayRequest getRelayRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetRelayRequest.builder()- Parameters:
getRelayRequest- AConsumerthat will call methods onGetRelayRequest.Builderto 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:
- AWS API Documentation
-
getRuleSet
default CompletableFuture<GetRuleSetResponse> getRuleSet(GetRuleSetRequest getRuleSetRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetRuleSetRequest.builder()- Parameters:
getRuleSetRequest- AConsumerthat will call methods onGetRuleSetRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetTrafficPolicyRequest.builder()- Parameters:
getTrafficPolicyRequest- AConsumerthat will call methods onGetTrafficPolicyRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAddonInstancesRequest.builder()- Parameters:
listAddonInstancesRequest- AConsumerthat will call methods onListAddonInstancesRequest.Builderto 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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListAddonInstancesPublisher publisher = client.listAddonInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListAddonInstancesPublisher publisher = client.listAddonInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListAddonInstancesRequest.builder()- Parameters:
listAddonInstancesRequest- AConsumerthat will call methods onListAddonInstancesRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAddonSubscriptionsRequest.builder()- Parameters:
listAddonSubscriptionsRequest- AConsumerthat will call methods onListAddonSubscriptionsRequest.Builderto 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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListAddonSubscriptionsPublisher publisher = client.listAddonSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListAddonSubscriptionsPublisher publisher = client.listAddonSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListAddonSubscriptionsRequest.builder()- Parameters:
listAddonSubscriptionsRequest- AConsumerthat will call methods onListAddonSubscriptionsRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListArchiveExportsRequest.builder()- Parameters:
listArchiveExportsRequest- AConsumerthat will call methods onListArchiveExportsRequest.Builderto 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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListArchiveExportsPublisher publisher = client.listArchiveExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListArchiveExportsPublisher publisher = client.listArchiveExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListArchiveExportsRequest.builder()- Parameters:
listArchiveExportsRequest- AConsumerthat will call methods onListArchiveExportsRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListArchiveSearchesRequest.builder()- Parameters:
listArchiveSearchesRequest- AConsumerthat will call methods onListArchiveSearchesRequest.Builderto 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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListArchiveSearchesPublisher publisher = client.listArchiveSearchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListArchiveSearchesPublisher publisher = client.listArchiveSearchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListArchiveSearchesRequest.builder()- Parameters:
listArchiveSearchesRequest- AConsumerthat will call methods onListArchiveSearchesRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListArchivesRequest.builder()- Parameters:
listArchivesRequest- AConsumerthat will call methods onListArchivesRequest.Builderto 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:
- AWS API Documentation
-
listArchivesPaginator
default ListArchivesPublisher listArchivesPaginator(ListArchivesRequest 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListArchivesPublisher publisher = client.listArchivesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListArchivesPublisher publisher = client.listArchivesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListArchivesRequest.builder()- Parameters:
listArchivesRequest- AConsumerthat will call methods onListArchivesRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListIngressPointsRequest.builder()- Parameters:
listIngressPointsRequest- AConsumerthat will call methods onListIngressPointsRequest.Builderto 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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListIngressPointsPublisher publisher = client.listIngressPointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListIngressPointsPublisher publisher = client.listIngressPointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListIngressPointsRequest.builder()- Parameters:
listIngressPointsRequest- AConsumerthat will call methods onListIngressPointsRequest.Builderto 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:
- AWS API Documentation
-
listRelays
default CompletableFuture<ListRelaysResponse> listRelays(ListRelaysRequest listRelaysRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListRelaysRequest.builder()- Parameters:
listRelaysRequest- AConsumerthat will call methods onListRelaysRequest.Builderto 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:
- AWS API Documentation
-
listRelaysPaginator
default ListRelaysPublisher listRelaysPaginator(ListRelaysRequest 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListRelaysPublisher publisher = client.listRelaysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListRelaysPublisher publisher = client.listRelaysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListRelaysRequest.builder()- Parameters:
listRelaysRequest- AConsumerthat will call methods onListRelaysRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListRuleSetsRequest.builder()- Parameters:
listRuleSetsRequest- AConsumerthat will call methods onListRuleSetsRequest.Builderto 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:
- AWS API Documentation
-
listRuleSetsPaginator
default ListRuleSetsPublisher listRuleSetsPaginator(ListRuleSetsRequest 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListRuleSetsPublisher publisher = client.listRuleSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListRuleSetsPublisher publisher = client.listRuleSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListRuleSetsRequest.builder()- Parameters:
listRuleSetsRequest- AConsumerthat will call methods onListRuleSetsRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
listTrafficPolicies
default CompletableFuture<ListTrafficPoliciesResponse> listTrafficPolicies(Consumer<ListTrafficPoliciesRequest.Builder> listTrafficPoliciesRequest)
List traffic policy resources.
This is a convenience which creates an instance of the
ListTrafficPoliciesRequest.Builderavoiding the need to create one manually viaListTrafficPoliciesRequest.builder()- Parameters:
listTrafficPoliciesRequest- AConsumerthat will call methods onListTrafficPoliciesRequest.Builderto 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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListTrafficPoliciesPublisher publisher = client.listTrafficPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.mailmanager.paginators.ListTrafficPoliciesPublisher publisher = client.listTrafficPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListTrafficPoliciesRequest.builder()- Parameters:
listTrafficPoliciesRequest- AConsumerthat will call methods onListTrafficPoliciesRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStartArchiveExportRequest.builder()- Parameters:
startArchiveExportRequest- AConsumerthat will call methods onStartArchiveExportRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStartArchiveSearchRequest.builder()- Parameters:
startArchiveSearchRequest- AConsumerthat will call methods onStartArchiveSearchRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStopArchiveExportRequest.builder()- Parameters:
stopArchiveExportRequest- AConsumerthat will call methods onStopArchiveExportRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStopArchiveSearchRequest.builder()- Parameters:
stopArchiveSearchRequest- AConsumerthat will call methods onStopArchiveSearchRequest.Builderto 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:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateArchiveRequest.builder()- Parameters:
updateArchiveRequest- AConsumerthat will call methods onUpdateArchiveRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateIngressPointRequest.builder()- Parameters:
updateIngressPointRequest- AConsumerthat will call methods onUpdateIngressPointRequest.Builderto 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:
- AWS API Documentation
-
updateRelay
default CompletableFuture<UpdateRelayResponse> updateRelay(UpdateRelayRequest updateRelayRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateRelayRequest.builder()- Parameters:
updateRelayRequest- AConsumerthat will call methods onUpdateRelayRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateRuleSetRequest.builder()- Parameters:
updateRuleSetRequest- AConsumerthat will call methods onUpdateRuleSetRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateTrafficPolicyRequest.builder()- Parameters:
updateTrafficPolicyRequest- AConsumerthat will call methods onUpdateTrafficPolicyRequest.Builderto 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:
- AWS API Documentation
-
serviceClientConfiguration
default MailManagerServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static MailManagerAsyncClient create()
Create aMailManagerAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static MailManagerAsyncClientBuilder builder()
Create a builder that can be used to configure and create aMailManagerAsyncClient.
-
-