Interface PinpointEmailAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.
Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aPinpointEmailAsyncClient
.static PinpointEmailAsyncClient
create()
Create aPinpointEmailAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createConfigurationSet
(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Create a configuration set.createConfigurationSet
(CreateConfigurationSetRequest createConfigurationSetRequest) Create a configuration set.createConfigurationSetEventDestination
(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) Create an event destination.createConfigurationSetEventDestination
(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) Create an event destination.createDedicatedIpPool
(Consumer<CreateDedicatedIpPoolRequest.Builder> createDedicatedIpPoolRequest) Create a new pool of dedicated IP addresses.createDedicatedIpPool
(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest) Create a new pool of dedicated IP addresses.createDeliverabilityTestReport
(Consumer<CreateDeliverabilityTestReportRequest.Builder> createDeliverabilityTestReportRequest) Create a new predictive inbox placement test.createDeliverabilityTestReport
(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest) Create a new predictive inbox placement test.createEmailIdentity
(Consumer<CreateEmailIdentityRequest.Builder> createEmailIdentityRequest) Verifies an email identity for use with Amazon Pinpoint.createEmailIdentity
(CreateEmailIdentityRequest createEmailIdentityRequest) Verifies an email identity for use with Amazon Pinpoint.deleteConfigurationSet
(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) Delete an existing configuration set.deleteConfigurationSet
(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Delete an existing configuration set.deleteConfigurationSetEventDestination
(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) Delete an event destination.deleteConfigurationSetEventDestination
(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Delete an event destination.deleteDedicatedIpPool
(Consumer<DeleteDedicatedIpPoolRequest.Builder> deleteDedicatedIpPoolRequest) Delete a dedicated IP pool.deleteDedicatedIpPool
(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest) Delete a dedicated IP pool.deleteEmailIdentity
(Consumer<DeleteEmailIdentityRequest.Builder> deleteEmailIdentityRequest) Deletes an email identity that you previously verified for use with Amazon Pinpoint.deleteEmailIdentity
(DeleteEmailIdentityRequest deleteEmailIdentityRequest) Deletes an email identity that you previously verified for use with Amazon Pinpoint.default CompletableFuture
<GetAccountResponse> Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.default CompletableFuture
<GetAccountResponse> getAccount
(Consumer<GetAccountRequest.Builder> getAccountRequest) Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.default CompletableFuture
<GetAccountResponse> getAccount
(GetAccountRequest getAccountRequest) Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.getBlacklistReports
(Consumer<GetBlacklistReportsRequest.Builder> getBlacklistReportsRequest) Retrieve a list of the blacklists that your dedicated IP addresses appear on.getBlacklistReports
(GetBlacklistReportsRequest getBlacklistReportsRequest) Retrieve a list of the blacklists that your dedicated IP addresses appear on.getConfigurationSet
(Consumer<GetConfigurationSetRequest.Builder> getConfigurationSetRequest) Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.getConfigurationSet
(GetConfigurationSetRequest getConfigurationSetRequest) Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.getConfigurationSetEventDestinations
(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest) Retrieve a list of event destinations that are associated with a configuration set.getConfigurationSetEventDestinations
(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest) Retrieve a list of event destinations that are associated with a configuration set.default CompletableFuture
<GetDedicatedIpResponse> getDedicatedIp
(Consumer<GetDedicatedIpRequest.Builder> getDedicatedIpRequest) Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.default CompletableFuture
<GetDedicatedIpResponse> getDedicatedIp
(GetDedicatedIpRequest getDedicatedIpRequest) Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.default CompletableFuture
<GetDedicatedIpsResponse> getDedicatedIps
(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest) List the dedicated IP addresses that are associated with your Amazon Pinpoint account.default CompletableFuture
<GetDedicatedIpsResponse> getDedicatedIps
(GetDedicatedIpsRequest getDedicatedIpsRequest) List the dedicated IP addresses that are associated with your Amazon Pinpoint account.default GetDedicatedIpsPublisher
getDedicatedIpsPaginator
(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest) This is a variant ofgetDedicatedIps(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest)
operation.default GetDedicatedIpsPublisher
getDedicatedIpsPaginator
(GetDedicatedIpsRequest getDedicatedIpsRequest) This is a variant ofgetDedicatedIps(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest)
operation.Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.getDeliverabilityDashboardOptions
(Consumer<GetDeliverabilityDashboardOptionsRequest.Builder> getDeliverabilityDashboardOptionsRequest) Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.getDeliverabilityDashboardOptions
(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest) Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.getDeliverabilityTestReport
(Consumer<GetDeliverabilityTestReportRequest.Builder> getDeliverabilityTestReportRequest) Retrieve the results of a predictive inbox placement test.getDeliverabilityTestReport
(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest) Retrieve the results of a predictive inbox placement test.getDomainDeliverabilityCampaign
(Consumer<GetDomainDeliverabilityCampaignRequest.Builder> getDomainDeliverabilityCampaignRequest) Retrieve all the deliverability data for a specific campaign.getDomainDeliverabilityCampaign
(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest) Retrieve all the deliverability data for a specific campaign.getDomainStatisticsReport
(Consumer<GetDomainStatisticsReportRequest.Builder> getDomainStatisticsReportRequest) Retrieve inbox placement and engagement rates for the domains that you use to send email.getDomainStatisticsReport
(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest) Retrieve inbox placement and engagement rates for the domains that you use to send email.getEmailIdentity
(Consumer<GetEmailIdentityRequest.Builder> getEmailIdentityRequest) Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.getEmailIdentity
(GetEmailIdentityRequest getEmailIdentityRequest) Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.listConfigurationSets
(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.listConfigurationSets
(ListConfigurationSetsRequest listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.default ListConfigurationSetsPublisher
listConfigurationSetsPaginator
(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) This is a variant oflistConfigurationSets(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest)
operation.default ListConfigurationSetsPublisher
listConfigurationSetsPaginator
(ListConfigurationSetsRequest listConfigurationSetsRequest) This is a variant oflistConfigurationSets(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest)
operation.listDedicatedIpPools
(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest) List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.listDedicatedIpPools
(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest) List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.default ListDedicatedIpPoolsPublisher
listDedicatedIpPoolsPaginator
(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest) This is a variant oflistDedicatedIpPools(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest)
operation.default ListDedicatedIpPoolsPublisher
listDedicatedIpPoolsPaginator
(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest) This is a variant oflistDedicatedIpPools(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest)
operation.listDeliverabilityTestReports
(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest) Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.listDeliverabilityTestReports
(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.listDeliverabilityTestReportsPaginator
(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest) This is a variant oflistDeliverabilityTestReports(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest)
operation.listDeliverabilityTestReportsPaginator
(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) This is a variant oflistDeliverabilityTestReports(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest)
operation.listDomainDeliverabilityCampaigns
(Consumer<ListDomainDeliverabilityCampaignsRequest.Builder> listDomainDeliverabilityCampaignsRequest) Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.listDomainDeliverabilityCampaigns
(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.listDomainDeliverabilityCampaignsPaginator
(Consumer<ListDomainDeliverabilityCampaignsRequest.Builder> listDomainDeliverabilityCampaignsRequest) This is a variant oflistDomainDeliverabilityCampaigns(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest)
operation.listDomainDeliverabilityCampaignsPaginator
(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) This is a variant oflistDomainDeliverabilityCampaigns(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest)
operation.listEmailIdentities
(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest) Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.listEmailIdentities
(ListEmailIdentitiesRequest listEmailIdentitiesRequest) Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.default ListEmailIdentitiesPublisher
listEmailIdentitiesPaginator
(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest) This is a variant oflistEmailIdentities(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest)
operation.default ListEmailIdentitiesPublisher
listEmailIdentitiesPaginator
(ListEmailIdentitiesRequest listEmailIdentitiesRequest) This is a variant oflistEmailIdentities(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieve a list of the tags (keys and values) that are associated with a specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieve a list of the tags (keys and values) that are associated with a specified resource.putAccountDedicatedIpWarmupAttributes
(Consumer<PutAccountDedicatedIpWarmupAttributesRequest.Builder> putAccountDedicatedIpWarmupAttributesRequest) Enable or disable the automatic warm-up feature for dedicated IP addresses.putAccountDedicatedIpWarmupAttributes
(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest) Enable or disable the automatic warm-up feature for dedicated IP addresses.putAccountSendingAttributes
(Consumer<PutAccountSendingAttributesRequest.Builder> putAccountSendingAttributesRequest) Enable or disable the ability of your account to send email.putAccountSendingAttributes
(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest) Enable or disable the ability of your account to send email.putConfigurationSetDeliveryOptions
(Consumer<PutConfigurationSetDeliveryOptionsRequest.Builder> putConfigurationSetDeliveryOptionsRequest) Associate a configuration set with a dedicated IP pool.putConfigurationSetDeliveryOptions
(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest) Associate a configuration set with a dedicated IP pool.putConfigurationSetReputationOptions
(Consumer<PutConfigurationSetReputationOptionsRequest.Builder> putConfigurationSetReputationOptionsRequest) Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.putConfigurationSetReputationOptions
(PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest) Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.putConfigurationSetSendingOptions
(Consumer<PutConfigurationSetSendingOptionsRequest.Builder> putConfigurationSetSendingOptionsRequest) Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.putConfigurationSetSendingOptions
(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest) Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.putConfigurationSetTrackingOptions
(Consumer<PutConfigurationSetTrackingOptionsRequest.Builder> putConfigurationSetTrackingOptionsRequest) Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.putConfigurationSetTrackingOptions
(PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest) Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.putDedicatedIpInPool
(Consumer<PutDedicatedIpInPoolRequest.Builder> putDedicatedIpInPoolRequest) Move a dedicated IP address to an existing dedicated IP pool.putDedicatedIpInPool
(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest) Move a dedicated IP address to an existing dedicated IP pool.putDedicatedIpWarmupAttributes
(Consumer<PutDedicatedIpWarmupAttributesRequest.Builder> putDedicatedIpWarmupAttributesRequest) putDedicatedIpWarmupAttributes
(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest) putDeliverabilityDashboardOption
(Consumer<PutDeliverabilityDashboardOptionRequest.Builder> putDeliverabilityDashboardOptionRequest) Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.putDeliverabilityDashboardOption
(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest) Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.putEmailIdentityDkimAttributes
(Consumer<PutEmailIdentityDkimAttributesRequest.Builder> putEmailIdentityDkimAttributesRequest) Used to enable or disable DKIM authentication for an email identity.putEmailIdentityDkimAttributes
(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest) Used to enable or disable DKIM authentication for an email identity.putEmailIdentityFeedbackAttributes
(Consumer<PutEmailIdentityFeedbackAttributesRequest.Builder> putEmailIdentityFeedbackAttributesRequest) Used to enable or disable feedback forwarding for an identity.putEmailIdentityFeedbackAttributes
(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest) Used to enable or disable feedback forwarding for an identity.putEmailIdentityMailFromAttributes
(Consumer<PutEmailIdentityMailFromAttributesRequest.Builder> putEmailIdentityMailFromAttributesRequest) Used to enable or disable the custom Mail-From domain configuration for an email identity.putEmailIdentityMailFromAttributes
(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest) Used to enable or disable the custom Mail-From domain configuration for an email identity.default CompletableFuture
<SendEmailResponse> sendEmail
(Consumer<SendEmailRequest.Builder> sendEmailRequest) Sends an email message.default CompletableFuture
<SendEmailResponse> sendEmail
(SendEmailRequest sendEmailRequest) Sends an email message.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add one or more tags (keys and values) to a specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Add one or more tags (keys and values) to a specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.updateConfigurationSetEventDestination
(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) Update the configuration of an event destination for a configuration set.updateConfigurationSetEventDestination
(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) Update the configuration of an event destination for a configuration set.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createConfigurationSet
default CompletableFuture<CreateConfigurationSetResponse> createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
- Parameters:
createConfigurationSetRequest
- A request to create a configuration set.- Returns:
- A Java Future containing the result of the CreateConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource specified in your request already exists.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSet
default CompletableFuture<CreateConfigurationSetResponse> createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
This is a convenience which creates an instance of the
CreateConfigurationSetRequest.Builder
avoiding the need to create one manually viaCreateConfigurationSetRequest.builder()
- Parameters:
createConfigurationSetRequest
- AConsumer
that will call methods onCreateConfigurationSetRequest.Builder
to create a request. A request to create a configuration set.- Returns:
- A Java Future containing the result of the CreateConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource specified in your request already exists.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSetEventDestination
default CompletableFuture<CreateConfigurationSetEventDestinationResponse> createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A single configuration set can include more than one event destination.
- Parameters:
createConfigurationSetEventDestinationRequest
- A request to add an event destination to a configuration set.- Returns:
- A Java Future containing the result of the CreateConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- AlreadyExistsException The resource specified in your request already exists.
- LimitExceededException There are too many instances of the specified resource type.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationSetEventDestination
default CompletableFuture<CreateConfigurationSetEventDestinationResponse> createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A single configuration set can include more than one event destination.
This is a convenience which creates an instance of the
CreateConfigurationSetEventDestinationRequest.Builder
avoiding the need to create one manually viaCreateConfigurationSetEventDestinationRequest.builder()
- Parameters:
createConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onCreateConfigurationSetEventDestinationRequest.Builder
to create a request. A request to add an event destination to a configuration set.- Returns:
- A Java Future containing the result of the CreateConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- AlreadyExistsException The resource specified in your request already exists.
- LimitExceededException There are too many instances of the specified resource type.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDedicatedIpPool
default CompletableFuture<CreateDedicatedIpPoolResponse> createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest) Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
- Parameters:
createDedicatedIpPoolRequest
- A request to create a new dedicated IP pool.- Returns:
- A Java Future containing the result of the CreateDedicatedIpPool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource specified in your request already exists.
- LimitExceededException There are too many instances of the specified resource type.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDedicatedIpPool
default CompletableFuture<CreateDedicatedIpPoolResponse> createDedicatedIpPool(Consumer<CreateDedicatedIpPoolRequest.Builder> createDedicatedIpPoolRequest) Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
This is a convenience which creates an instance of the
CreateDedicatedIpPoolRequest.Builder
avoiding the need to create one manually viaCreateDedicatedIpPoolRequest.builder()
- Parameters:
createDedicatedIpPoolRequest
- AConsumer
that will call methods onCreateDedicatedIpPoolRequest.Builder
to create a request. A request to create a new dedicated IP pool.- Returns:
- A Java Future containing the result of the CreateDedicatedIpPool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource specified in your request already exists.
- LimitExceededException There are too many instances of the specified resource type.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeliverabilityTestReport
default CompletableFuture<CreateDeliverabilityTestReportResponse> createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest) Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the
GetDeliverabilityTestReport
operation to view the results of the test.- Parameters:
createDeliverabilityTestReportRequest
- A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use theGetDeliverabilityTestReport
operation to view the results of the test.- Returns:
- A Java Future containing the result of the CreateDeliverabilityTestReport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccountSuspendedException The message can't be sent because the account's ability to send email has been permanently restricted.
- SendingPausedException The message can't be sent because the account's ability to send email is currently paused.
- MessageRejectedException The message can't be sent because it contains invalid content.
- MailFromDomainNotVerifiedException The message can't be sent because the sending domain isn't verified.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeliverabilityTestReport
default CompletableFuture<CreateDeliverabilityTestReportResponse> createDeliverabilityTestReport(Consumer<CreateDeliverabilityTestReportRequest.Builder> createDeliverabilityTestReportRequest) Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the
GetDeliverabilityTestReport
operation to view the results of the test.
This is a convenience which creates an instance of the
CreateDeliverabilityTestReportRequest.Builder
avoiding the need to create one manually viaCreateDeliverabilityTestReportRequest.builder()
- Parameters:
createDeliverabilityTestReportRequest
- AConsumer
that will call methods onCreateDeliverabilityTestReportRequest.Builder
to create a request. A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use theGetDeliverabilityTestReport
operation to view the results of the test.- Returns:
- A Java Future containing the result of the CreateDeliverabilityTestReport operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccountSuspendedException The message can't be sent because the account's ability to send email has been permanently restricted.
- SendingPausedException The message can't be sent because the account's ability to send email is currently paused.
- MessageRejectedException The message can't be sent because it contains invalid content.
- MailFromDomainNotVerifiedException The message can't be sent because the sending domain isn't verified.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEmailIdentity
default CompletableFuture<CreateEmailIdentityResponse> createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest) Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.
When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
- Parameters:
createEmailIdentityRequest
- A request to begin the verification process for an email identity (an email address or domain).- Returns:
- A Java Future containing the result of the CreateEmailIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException There are too many instances of the specified resource type.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEmailIdentity
default CompletableFuture<CreateEmailIdentityResponse> createEmailIdentity(Consumer<CreateEmailIdentityRequest.Builder> createEmailIdentityRequest) Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.
When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
This is a convenience which creates an instance of the
CreateEmailIdentityRequest.Builder
avoiding the need to create one manually viaCreateEmailIdentityRequest.builder()
- Parameters:
createEmailIdentityRequest
- AConsumer
that will call methods onCreateEmailIdentityRequest.Builder
to create a request. A request to begin the verification process for an email identity (an email address or domain).- Returns:
- A Java Future containing the result of the CreateEmailIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException There are too many instances of the specified resource type.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSet
default CompletableFuture<DeleteConfigurationSetResponse> deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Delete an existing configuration set.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
- Parameters:
deleteConfigurationSetRequest
- A request to delete a configuration set.- Returns:
- A Java Future containing the result of the DeleteConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSet
default CompletableFuture<DeleteConfigurationSetResponse> deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) Delete an existing configuration set.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
This is a convenience which creates an instance of the
DeleteConfigurationSetRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationSetRequest.builder()
- Parameters:
deleteConfigurationSetRequest
- AConsumer
that will call methods onDeleteConfigurationSetRequest.Builder
to create a request. A request to delete a configuration set.- Returns:
- A Java Future containing the result of the DeleteConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSetEventDestination
default CompletableFuture<DeleteConfigurationSetEventDestinationResponse> deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) Delete an event destination.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
- Parameters:
deleteConfigurationSetEventDestinationRequest
- A request to delete an event destination from a configuration set.- Returns:
- A Java Future containing the result of the DeleteConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationSetEventDestination
default CompletableFuture<DeleteConfigurationSetEventDestinationResponse> deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) Delete an event destination.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
This is a convenience which creates an instance of the
DeleteConfigurationSetEventDestinationRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationSetEventDestinationRequest.builder()
- Parameters:
deleteConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onDeleteConfigurationSetEventDestinationRequest.Builder
to create a request. A request to delete an event destination from a configuration set.- Returns:
- A Java Future containing the result of the DeleteConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDedicatedIpPool
default CompletableFuture<DeleteDedicatedIpPoolResponse> deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest) Delete a dedicated IP pool.
- Parameters:
deleteDedicatedIpPoolRequest
- A request to delete a dedicated IP pool.- Returns:
- A Java Future containing the result of the DeleteDedicatedIpPool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDedicatedIpPool
default CompletableFuture<DeleteDedicatedIpPoolResponse> deleteDedicatedIpPool(Consumer<DeleteDedicatedIpPoolRequest.Builder> deleteDedicatedIpPoolRequest) Delete a dedicated IP pool.
This is a convenience which creates an instance of the
DeleteDedicatedIpPoolRequest.Builder
avoiding the need to create one manually viaDeleteDedicatedIpPoolRequest.builder()
- Parameters:
deleteDedicatedIpPoolRequest
- AConsumer
that will call methods onDeleteDedicatedIpPoolRequest.Builder
to create a request. A request to delete a dedicated IP pool.- Returns:
- A Java Future containing the result of the DeleteDedicatedIpPool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEmailIdentity
default CompletableFuture<DeleteEmailIdentityResponse> deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest) Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
- Parameters:
deleteEmailIdentityRequest
- A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.- Returns:
- A Java Future containing the result of the DeleteEmailIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEmailIdentity
default CompletableFuture<DeleteEmailIdentityResponse> deleteEmailIdentity(Consumer<DeleteEmailIdentityRequest.Builder> deleteEmailIdentityRequest) Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
This is a convenience which creates an instance of the
DeleteEmailIdentityRequest.Builder
avoiding the need to create one manually viaDeleteEmailIdentityRequest.builder()
- Parameters:
deleteEmailIdentityRequest
- AConsumer
that will call methods onDeleteEmailIdentityRequest.Builder
to create a request. A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.- Returns:
- A Java Future containing the result of the DeleteEmailIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccount
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
- Parameters:
getAccountRequest
- A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.- Returns:
- A Java Future containing the result of the GetAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccount
default CompletableFuture<GetAccountResponse> getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest) Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
This is a convenience which creates an instance of the
GetAccountRequest.Builder
avoiding the need to create one manually viaGetAccountRequest.builder()
- Parameters:
getAccountRequest
- AConsumer
that will call methods onGetAccountRequest.Builder
to create a request. A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.- Returns:
- A Java Future containing the result of the GetAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccount
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
- Returns:
- A Java Future containing the result of the GetAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBlacklistReports
default CompletableFuture<GetBlacklistReportsResponse> getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest) Retrieve a list of the blacklists that your dedicated IP addresses appear on.
- Parameters:
getBlacklistReportsRequest
- A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.- Returns:
- A Java Future containing the result of the GetBlacklistReports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBlacklistReports
default CompletableFuture<GetBlacklistReportsResponse> getBlacklistReports(Consumer<GetBlacklistReportsRequest.Builder> getBlacklistReportsRequest) Retrieve a list of the blacklists that your dedicated IP addresses appear on.
This is a convenience which creates an instance of the
GetBlacklistReportsRequest.Builder
avoiding the need to create one manually viaGetBlacklistReportsRequest.builder()
- Parameters:
getBlacklistReportsRequest
- AConsumer
that will call methods onGetBlacklistReportsRequest.Builder
to create a request. A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.- Returns:
- A Java Future containing the result of the GetBlacklistReports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConfigurationSet
default CompletableFuture<GetConfigurationSetResponse> getConfigurationSet(GetConfigurationSetRequest getConfigurationSetRequest) Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
- Parameters:
getConfigurationSetRequest
- A request to obtain information about a configuration set.- Returns:
- A Java Future containing the result of the GetConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConfigurationSet
default CompletableFuture<GetConfigurationSetResponse> getConfigurationSet(Consumer<GetConfigurationSetRequest.Builder> getConfigurationSetRequest) Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
This is a convenience which creates an instance of the
GetConfigurationSetRequest.Builder
avoiding the need to create one manually viaGetConfigurationSetRequest.builder()
- Parameters:
getConfigurationSetRequest
- AConsumer
that will call methods onGetConfigurationSetRequest.Builder
to create a request. A request to obtain information about a configuration set.- Returns:
- A Java Future containing the result of the GetConfigurationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConfigurationSetEventDestinations
default CompletableFuture<GetConfigurationSetEventDestinationsResponse> getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest) Retrieve a list of event destinations that are associated with a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
- Parameters:
getConfigurationSetEventDestinationsRequest
- A request to obtain information about the event destinations for a configuration set.- Returns:
- A Java Future containing the result of the GetConfigurationSetEventDestinations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConfigurationSetEventDestinations
default CompletableFuture<GetConfigurationSetEventDestinationsResponse> getConfigurationSetEventDestinations(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest) Retrieve a list of event destinations that are associated with a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
This is a convenience which creates an instance of the
GetConfigurationSetEventDestinationsRequest.Builder
avoiding the need to create one manually viaGetConfigurationSetEventDestinationsRequest.builder()
- Parameters:
getConfigurationSetEventDestinationsRequest
- AConsumer
that will call methods onGetConfigurationSetEventDestinationsRequest.Builder
to create a request. A request to obtain information about the event destinations for a configuration set.- Returns:
- A Java Future containing the result of the GetConfigurationSetEventDestinations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDedicatedIp
default CompletableFuture<GetDedicatedIpResponse> getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest) Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
- Parameters:
getDedicatedIpRequest
- A request to obtain more information about a dedicated IP address.- Returns:
- A Java Future containing the result of the GetDedicatedIp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDedicatedIp
default CompletableFuture<GetDedicatedIpResponse> getDedicatedIp(Consumer<GetDedicatedIpRequest.Builder> getDedicatedIpRequest) Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
This is a convenience which creates an instance of the
GetDedicatedIpRequest.Builder
avoiding the need to create one manually viaGetDedicatedIpRequest.builder()
- Parameters:
getDedicatedIpRequest
- AConsumer
that will call methods onGetDedicatedIpRequest.Builder
to create a request. A request to obtain more information about a dedicated IP address.- Returns:
- A Java Future containing the result of the GetDedicatedIp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDedicatedIps
default CompletableFuture<GetDedicatedIpsResponse> getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest) List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
- Parameters:
getDedicatedIpsRequest
- A request to obtain more information about dedicated IP pools.- Returns:
- A Java Future containing the result of the GetDedicatedIps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDedicatedIps
default CompletableFuture<GetDedicatedIpsResponse> getDedicatedIps(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest) List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
This is a convenience which creates an instance of the
GetDedicatedIpsRequest.Builder
avoiding the need to create one manually viaGetDedicatedIpsRequest.builder()
- Parameters:
getDedicatedIpsRequest
- AConsumer
that will call methods onGetDedicatedIpsRequest.Builder
to create a request. A request to obtain more information about dedicated IP pools.- Returns:
- A Java Future containing the result of the GetDedicatedIps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDedicatedIpsPaginator
default GetDedicatedIpsPublisher getDedicatedIpsPaginator(GetDedicatedIpsRequest getDedicatedIpsRequest) This is a variant of
getDedicatedIps(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsPublisher publisher = client.getDedicatedIpsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsPublisher publisher = client.getDedicatedIpsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse 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
getDedicatedIps(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest)
operation.- Parameters:
getDedicatedIpsRequest
- A request to obtain more information about dedicated IP pools.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDedicatedIpsPaginator
default GetDedicatedIpsPublisher getDedicatedIpsPaginator(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest) This is a variant of
getDedicatedIps(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsPublisher publisher = client.getDedicatedIpsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsPublisher publisher = client.getDedicatedIpsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse 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
getDedicatedIps(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest)
operation.
This is a convenience which creates an instance of the
GetDedicatedIpsRequest.Builder
avoiding the need to create one manually viaGetDedicatedIpsRequest.builder()
- Parameters:
getDedicatedIpsRequest
- AConsumer
that will call methods onGetDedicatedIpsRequest.Builder
to create a request. A request to obtain more information about dedicated IP pools.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeliverabilityDashboardOptions
default CompletableFuture<GetDeliverabilityDashboardOptionsResponse> getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest) Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Parameters:
getDeliverabilityDashboardOptionsRequest
- Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- A Java Future containing the result of the GetDeliverabilityDashboardOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeliverabilityDashboardOptions
default CompletableFuture<GetDeliverabilityDashboardOptionsResponse> getDeliverabilityDashboardOptions(Consumer<GetDeliverabilityDashboardOptionsRequest.Builder> getDeliverabilityDashboardOptionsRequest) Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
This is a convenience which creates an instance of the
GetDeliverabilityDashboardOptionsRequest.Builder
avoiding the need to create one manually viaGetDeliverabilityDashboardOptionsRequest.builder()
- Parameters:
getDeliverabilityDashboardOptionsRequest
- AConsumer
that will call methods onGetDeliverabilityDashboardOptionsRequest.Builder
to create a request. Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- A Java Future containing the result of the GetDeliverabilityDashboardOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeliverabilityDashboardOptions
default CompletableFuture<GetDeliverabilityDashboardOptionsResponse> getDeliverabilityDashboardOptions()Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- A Java Future containing the result of the GetDeliverabilityDashboardOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeliverabilityTestReport
default CompletableFuture<GetDeliverabilityTestReportResponse> getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest) Retrieve the results of a predictive inbox placement test.
- Parameters:
getDeliverabilityTestReportRequest
- A request to retrieve the results of a predictive inbox placement test.- Returns:
- A Java Future containing the result of the GetDeliverabilityTestReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeliverabilityTestReport
default CompletableFuture<GetDeliverabilityTestReportResponse> getDeliverabilityTestReport(Consumer<GetDeliverabilityTestReportRequest.Builder> getDeliverabilityTestReportRequest) Retrieve the results of a predictive inbox placement test.
This is a convenience which creates an instance of the
GetDeliverabilityTestReportRequest.Builder
avoiding the need to create one manually viaGetDeliverabilityTestReportRequest.builder()
- Parameters:
getDeliverabilityTestReportRequest
- AConsumer
that will call methods onGetDeliverabilityTestReportRequest.Builder
to create a request. A request to retrieve the results of a predictive inbox placement test.- Returns:
- A Java Future containing the result of the GetDeliverabilityTestReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainDeliverabilityCampaign
default CompletableFuture<GetDomainDeliverabilityCampaignResponse> getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest) Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption
operation).- Parameters:
getDomainDeliverabilityCampaignRequest
- Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption
operation).- Returns:
- A Java Future containing the result of the GetDomainDeliverabilityCampaign operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- NotFoundException The resource you attempted to access doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainDeliverabilityCampaign
default CompletableFuture<GetDomainDeliverabilityCampaignResponse> getDomainDeliverabilityCampaign(Consumer<GetDomainDeliverabilityCampaignRequest.Builder> getDomainDeliverabilityCampaignRequest) Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption
operation).
This is a convenience which creates an instance of the
GetDomainDeliverabilityCampaignRequest.Builder
avoiding the need to create one manually viaGetDomainDeliverabilityCampaignRequest.builder()
- Parameters:
getDomainDeliverabilityCampaignRequest
- AConsumer
that will call methods onGetDomainDeliverabilityCampaignRequest.Builder
to create a request. Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption
operation).- Returns:
- A Java Future containing the result of the GetDomainDeliverabilityCampaign operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- NotFoundException The resource you attempted to access doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainStatisticsReport
default CompletableFuture<GetDomainStatisticsReportResponse> getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest) Retrieve inbox placement and engagement rates for the domains that you use to send email.
- Parameters:
getDomainStatisticsReportRequest
- A request to obtain deliverability metrics for a domain.- Returns:
- A Java Future containing the result of the GetDomainStatisticsReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainStatisticsReport
default CompletableFuture<GetDomainStatisticsReportResponse> getDomainStatisticsReport(Consumer<GetDomainStatisticsReportRequest.Builder> getDomainStatisticsReportRequest) Retrieve inbox placement and engagement rates for the domains that you use to send email.
This is a convenience which creates an instance of the
GetDomainStatisticsReportRequest.Builder
avoiding the need to create one manually viaGetDomainStatisticsReportRequest.builder()
- Parameters:
getDomainStatisticsReportRequest
- AConsumer
that will call methods onGetDomainStatisticsReportRequest.Builder
to create a request. A request to obtain deliverability metrics for a domain.- Returns:
- A Java Future containing the result of the GetDomainStatisticsReport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEmailIdentity
default CompletableFuture<GetEmailIdentityResponse> getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest) Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
- Parameters:
getEmailIdentityRequest
- A request to return details about an email identity.- Returns:
- A Java Future containing the result of the GetEmailIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEmailIdentity
default CompletableFuture<GetEmailIdentityResponse> getEmailIdentity(Consumer<GetEmailIdentityRequest.Builder> getEmailIdentityRequest) Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
This is a convenience which creates an instance of the
GetEmailIdentityRequest.Builder
avoiding the need to create one manually viaGetEmailIdentityRequest.builder()
- Parameters:
getEmailIdentityRequest
- AConsumer
that will call methods onGetEmailIdentityRequest.Builder
to create a request. A request to return details about an email identity.- Returns:
- A Java Future containing the result of the GetEmailIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationSets
default CompletableFuture<ListConfigurationSetsResponse> listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
- Parameters:
listConfigurationSetsRequest
- A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.- Returns:
- A Java Future containing the result of the ListConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationSets
default CompletableFuture<ListConfigurationSetsResponse> listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
This is a convenience which creates an instance of the
ListConfigurationSetsRequest.Builder
avoiding the need to create one manually viaListConfigurationSetsRequest.builder()
- Parameters:
listConfigurationSetsRequest
- AConsumer
that will call methods onListConfigurationSetsRequest.Builder
to create a request. A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.- Returns:
- A Java Future containing the result of the ListConfigurationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationSetsPaginator
default ListConfigurationSetsPublisher listConfigurationSetsPaginator(ListConfigurationSetsRequest listConfigurationSetsRequest) This is a variant of
listConfigurationSets(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsPublisher publisher = client.listConfigurationSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsPublisher publisher = client.listConfigurationSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse 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
listConfigurationSets(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest)
operation.- Parameters:
listConfigurationSetsRequest
- A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationSetsPaginator
default ListConfigurationSetsPublisher listConfigurationSetsPaginator(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) This is a variant of
listConfigurationSets(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsPublisher publisher = client.listConfigurationSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsPublisher publisher = client.listConfigurationSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse 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
listConfigurationSets(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest)
operation.
This is a convenience which creates an instance of the
ListConfigurationSetsRequest.Builder
avoiding the need to create one manually viaListConfigurationSetsRequest.builder()
- Parameters:
listConfigurationSetsRequest
- AConsumer
that will call methods onListConfigurationSetsRequest.Builder
to create a request. A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDedicatedIpPools
default CompletableFuture<ListDedicatedIpPoolsResponse> listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest) List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
- Parameters:
listDedicatedIpPoolsRequest
- A request to obtain a list of dedicated IP pools.- Returns:
- A Java Future containing the result of the ListDedicatedIpPools operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDedicatedIpPools
default CompletableFuture<ListDedicatedIpPoolsResponse> listDedicatedIpPools(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest) List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
This is a convenience which creates an instance of the
ListDedicatedIpPoolsRequest.Builder
avoiding the need to create one manually viaListDedicatedIpPoolsRequest.builder()
- Parameters:
listDedicatedIpPoolsRequest
- AConsumer
that will call methods onListDedicatedIpPoolsRequest.Builder
to create a request. A request to obtain a list of dedicated IP pools.- Returns:
- A Java Future containing the result of the ListDedicatedIpPools operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDedicatedIpPoolsPaginator
default ListDedicatedIpPoolsPublisher listDedicatedIpPoolsPaginator(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest) This is a variant of
listDedicatedIpPools(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsPublisher publisher = client.listDedicatedIpPoolsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsPublisher publisher = client.listDedicatedIpPoolsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse 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
listDedicatedIpPools(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest)
operation.- Parameters:
listDedicatedIpPoolsRequest
- A request to obtain a list of dedicated IP pools.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDedicatedIpPoolsPaginator
default ListDedicatedIpPoolsPublisher listDedicatedIpPoolsPaginator(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest) This is a variant of
listDedicatedIpPools(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsPublisher publisher = client.listDedicatedIpPoolsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsPublisher publisher = client.listDedicatedIpPoolsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse 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
listDedicatedIpPools(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest)
operation.
This is a convenience which creates an instance of the
ListDedicatedIpPoolsRequest.Builder
avoiding the need to create one manually viaListDedicatedIpPoolsRequest.builder()
- Parameters:
listDedicatedIpPoolsRequest
- AConsumer
that will call methods onListDedicatedIpPoolsRequest.Builder
to create a request. A request to obtain a list of dedicated IP pools.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeliverabilityTestReports
default CompletableFuture<ListDeliverabilityTestReportsResponse> listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the
GetDeliverabilityTestReport
operation to view the results.- Parameters:
listDeliverabilityTestReportsRequest
- A request to list all of the predictive inbox placement tests that you've performed.- Returns:
- A Java Future containing the result of the ListDeliverabilityTestReports operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeliverabilityTestReports
default CompletableFuture<ListDeliverabilityTestReportsResponse> listDeliverabilityTestReports(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest) Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the
GetDeliverabilityTestReport
operation to view the results.
This is a convenience which creates an instance of the
ListDeliverabilityTestReportsRequest.Builder
avoiding the need to create one manually viaListDeliverabilityTestReportsRequest.builder()
- Parameters:
listDeliverabilityTestReportsRequest
- AConsumer
that will call methods onListDeliverabilityTestReportsRequest.Builder
to create a request. A request to list all of the predictive inbox placement tests that you've performed.- Returns:
- A Java Future containing the result of the ListDeliverabilityTestReports operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeliverabilityTestReportsPaginator
default ListDeliverabilityTestReportsPublisher listDeliverabilityTestReportsPaginator(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) This is a variant of
listDeliverabilityTestReports(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsPublisher publisher = client.listDeliverabilityTestReportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsPublisher publisher = client.listDeliverabilityTestReportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse 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
listDeliverabilityTestReports(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest)
operation.- Parameters:
listDeliverabilityTestReportsRequest
- A request to list all of the predictive inbox placement tests that you've performed.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeliverabilityTestReportsPaginator
default ListDeliverabilityTestReportsPublisher listDeliverabilityTestReportsPaginator(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest) This is a variant of
listDeliverabilityTestReports(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsPublisher publisher = client.listDeliverabilityTestReportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsPublisher publisher = client.listDeliverabilityTestReportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse 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
listDeliverabilityTestReports(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest)
operation.
This is a convenience which creates an instance of the
ListDeliverabilityTestReportsRequest.Builder
avoiding the need to create one manually viaListDeliverabilityTestReportsRequest.builder()
- Parameters:
listDeliverabilityTestReportsRequest
- AConsumer
that will call methods onListDeliverabilityTestReportsRequest.Builder
to create a request. A request to list all of the predictive inbox placement tests that you've performed.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainDeliverabilityCampaigns
default CompletableFuture<ListDomainDeliverabilityCampaignsResponse> listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (
PutDeliverabilityDashboardOption
operation) for the domain.- Parameters:
listDomainDeliverabilityCampaignsRequest
- Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption
operation) for the domain.- Returns:
- A Java Future containing the result of the ListDomainDeliverabilityCampaigns operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- NotFoundException The resource you attempted to access doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainDeliverabilityCampaigns
default CompletableFuture<ListDomainDeliverabilityCampaignsResponse> listDomainDeliverabilityCampaigns(Consumer<ListDomainDeliverabilityCampaignsRequest.Builder> listDomainDeliverabilityCampaignsRequest) Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (
PutDeliverabilityDashboardOption
operation) for the domain.
This is a convenience which creates an instance of the
ListDomainDeliverabilityCampaignsRequest.Builder
avoiding the need to create one manually viaListDomainDeliverabilityCampaignsRequest.builder()
- Parameters:
listDomainDeliverabilityCampaignsRequest
- AConsumer
that will call methods onListDomainDeliverabilityCampaignsRequest.Builder
to create a request. Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption
operation) for the domain.- Returns:
- A Java Future containing the result of the ListDomainDeliverabilityCampaigns operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- NotFoundException The resource you attempted to access doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainDeliverabilityCampaignsPaginator
default ListDomainDeliverabilityCampaignsPublisher listDomainDeliverabilityCampaignsPaginator(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) This is a variant of
listDomainDeliverabilityCampaigns(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsPublisher publisher = client.listDomainDeliverabilityCampaignsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsPublisher publisher = client.listDomainDeliverabilityCampaignsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse 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
listDomainDeliverabilityCampaigns(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest)
operation.- Parameters:
listDomainDeliverabilityCampaignsRequest
- Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption
operation) for the domain.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- NotFoundException The resource you attempted to access doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainDeliverabilityCampaignsPaginator
default ListDomainDeliverabilityCampaignsPublisher listDomainDeliverabilityCampaignsPaginator(Consumer<ListDomainDeliverabilityCampaignsRequest.Builder> listDomainDeliverabilityCampaignsRequest) This is a variant of
listDomainDeliverabilityCampaigns(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsPublisher publisher = client.listDomainDeliverabilityCampaignsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsPublisher publisher = client.listDomainDeliverabilityCampaignsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse 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
listDomainDeliverabilityCampaigns(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest)
operation.
This is a convenience which creates an instance of the
ListDomainDeliverabilityCampaignsRequest.Builder
avoiding the need to create one manually viaListDomainDeliverabilityCampaignsRequest.builder()
- Parameters:
listDomainDeliverabilityCampaignsRequest
- AConsumer
that will call methods onListDomainDeliverabilityCampaignsRequest.Builder
to create a request. Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption
operation) for the domain.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- NotFoundException The resource you attempted to access doesn't exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEmailIdentities
default CompletableFuture<ListEmailIdentitiesResponse> listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest) Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.
- Parameters:
listEmailIdentitiesRequest
- A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.- Returns:
- A Java Future containing the result of the ListEmailIdentities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEmailIdentities
default CompletableFuture<ListEmailIdentitiesResponse> listEmailIdentities(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest) Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.
This is a convenience which creates an instance of the
ListEmailIdentitiesRequest.Builder
avoiding the need to create one manually viaListEmailIdentitiesRequest.builder()
- Parameters:
listEmailIdentitiesRequest
- AConsumer
that will call methods onListEmailIdentitiesRequest.Builder
to create a request. A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.- Returns:
- A Java Future containing the result of the ListEmailIdentities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEmailIdentitiesPaginator
default ListEmailIdentitiesPublisher listEmailIdentitiesPaginator(ListEmailIdentitiesRequest listEmailIdentitiesRequest) This is a variant of
listEmailIdentities(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesPublisher publisher = client.listEmailIdentitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesPublisher publisher = client.listEmailIdentitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse 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
listEmailIdentities(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest)
operation.- Parameters:
listEmailIdentitiesRequest
- A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEmailIdentitiesPaginator
default ListEmailIdentitiesPublisher listEmailIdentitiesPaginator(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest) This is a variant of
listEmailIdentities(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesPublisher publisher = client.listEmailIdentitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesPublisher publisher = client.listEmailIdentitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse 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
listEmailIdentities(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest)
operation.
This is a convenience which creates an instance of the
ListEmailIdentitiesRequest.Builder
avoiding the need to create one manually viaListEmailIdentitiesRequest.builder()
- Parameters:
listEmailIdentitiesRequest
- AConsumer
that will call methods onListEmailIdentitiesRequest.Builder
to create a request. A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.- 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.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input you provided is invalid.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input you provided is invalid.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAccountDedicatedIpWarmupAttributes
default CompletableFuture<PutAccountDedicatedIpWarmupAttributesResponse> putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest) Enable or disable the automatic warm-up feature for dedicated IP addresses.
- Parameters:
putAccountDedicatedIpWarmupAttributesRequest
- A request to enable or disable the automatic IP address warm-up feature.- Returns:
- A Java Future containing the result of the PutAccountDedicatedIpWarmupAttributes operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAccountDedicatedIpWarmupAttributes
default CompletableFuture<PutAccountDedicatedIpWarmupAttributesResponse> putAccountDedicatedIpWarmupAttributes(Consumer<PutAccountDedicatedIpWarmupAttributesRequest.Builder> putAccountDedicatedIpWarmupAttributesRequest) Enable or disable the automatic warm-up feature for dedicated IP addresses.
This is a convenience which creates an instance of the
PutAccountDedicatedIpWarmupAttributesRequest.Builder
avoiding the need to create one manually viaPutAccountDedicatedIpWarmupAttributesRequest.builder()
- Parameters:
putAccountDedicatedIpWarmupAttributesRequest
- AConsumer
that will call methods onPutAccountDedicatedIpWarmupAttributesRequest.Builder
to create a request. A request to enable or disable the automatic IP address warm-up feature.- Returns:
- A Java Future containing the result of the PutAccountDedicatedIpWarmupAttributes operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAccountSendingAttributes
default CompletableFuture<PutAccountSendingAttributesResponse> putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest) Enable or disable the ability of your account to send email.
- Parameters:
putAccountSendingAttributesRequest
- A request to change the ability of your account to send email.- Returns:
- A Java Future containing the result of the PutAccountSendingAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAccountSendingAttributes
default CompletableFuture<PutAccountSendingAttributesResponse> putAccountSendingAttributes(Consumer<PutAccountSendingAttributesRequest.Builder> putAccountSendingAttributesRequest) Enable or disable the ability of your account to send email.
This is a convenience which creates an instance of the
PutAccountSendingAttributesRequest.Builder
avoiding the need to create one manually viaPutAccountSendingAttributesRequest.builder()
- Parameters:
putAccountSendingAttributesRequest
- AConsumer
that will call methods onPutAccountSendingAttributesRequest.Builder
to create a request. A request to change the ability of your account to send email.- Returns:
- A Java Future containing the result of the PutAccountSendingAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetDeliveryOptions
default CompletableFuture<PutConfigurationSetDeliveryOptionsResponse> putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest) Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
- Parameters:
putConfigurationSetDeliveryOptionsRequest
- A request to associate a configuration set with a dedicated IP pool.- Returns:
- A Java Future containing the result of the PutConfigurationSetDeliveryOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetDeliveryOptions
default CompletableFuture<PutConfigurationSetDeliveryOptionsResponse> putConfigurationSetDeliveryOptions(Consumer<PutConfigurationSetDeliveryOptionsRequest.Builder> putConfigurationSetDeliveryOptionsRequest) Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
This is a convenience which creates an instance of the
PutConfigurationSetDeliveryOptionsRequest.Builder
avoiding the need to create one manually viaPutConfigurationSetDeliveryOptionsRequest.builder()
- Parameters:
putConfigurationSetDeliveryOptionsRequest
- AConsumer
that will call methods onPutConfigurationSetDeliveryOptionsRequest.Builder
to create a request. A request to associate a configuration set with a dedicated IP pool.- Returns:
- A Java Future containing the result of the PutConfigurationSetDeliveryOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetReputationOptions
default CompletableFuture<PutConfigurationSetReputationOptionsResponse> putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest) Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
- Parameters:
putConfigurationSetReputationOptionsRequest
- A request to enable or disable tracking of reputation metrics for a configuration set.- Returns:
- A Java Future containing the result of the PutConfigurationSetReputationOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetReputationOptions
default CompletableFuture<PutConfigurationSetReputationOptionsResponse> putConfigurationSetReputationOptions(Consumer<PutConfigurationSetReputationOptionsRequest.Builder> putConfigurationSetReputationOptionsRequest) Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
This is a convenience which creates an instance of the
PutConfigurationSetReputationOptionsRequest.Builder
avoiding the need to create one manually viaPutConfigurationSetReputationOptionsRequest.builder()
- Parameters:
putConfigurationSetReputationOptionsRequest
- AConsumer
that will call methods onPutConfigurationSetReputationOptionsRequest.Builder
to create a request. A request to enable or disable tracking of reputation metrics for a configuration set.- Returns:
- A Java Future containing the result of the PutConfigurationSetReputationOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetSendingOptions
default CompletableFuture<PutConfigurationSetSendingOptionsResponse> putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest) Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
- Parameters:
putConfigurationSetSendingOptionsRequest
- A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.- Returns:
- A Java Future containing the result of the PutConfigurationSetSendingOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetSendingOptions
default CompletableFuture<PutConfigurationSetSendingOptionsResponse> putConfigurationSetSendingOptions(Consumer<PutConfigurationSetSendingOptionsRequest.Builder> putConfigurationSetSendingOptionsRequest) Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
This is a convenience which creates an instance of the
PutConfigurationSetSendingOptionsRequest.Builder
avoiding the need to create one manually viaPutConfigurationSetSendingOptionsRequest.builder()
- Parameters:
putConfigurationSetSendingOptionsRequest
- AConsumer
that will call methods onPutConfigurationSetSendingOptionsRequest.Builder
to create a request. A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.- Returns:
- A Java Future containing the result of the PutConfigurationSetSendingOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetTrackingOptions
default CompletableFuture<PutConfigurationSetTrackingOptionsResponse> putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest) Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
- Parameters:
putConfigurationSetTrackingOptionsRequest
- A request to add a custom domain for tracking open and click events to a configuration set.- Returns:
- A Java Future containing the result of the PutConfigurationSetTrackingOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationSetTrackingOptions
default CompletableFuture<PutConfigurationSetTrackingOptionsResponse> putConfigurationSetTrackingOptions(Consumer<PutConfigurationSetTrackingOptionsRequest.Builder> putConfigurationSetTrackingOptionsRequest) Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
This is a convenience which creates an instance of the
PutConfigurationSetTrackingOptionsRequest.Builder
avoiding the need to create one manually viaPutConfigurationSetTrackingOptionsRequest.builder()
- Parameters:
putConfigurationSetTrackingOptionsRequest
- AConsumer
that will call methods onPutConfigurationSetTrackingOptionsRequest.Builder
to create a request. A request to add a custom domain for tracking open and click events to a configuration set.- Returns:
- A Java Future containing the result of the PutConfigurationSetTrackingOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDedicatedIpInPool
default CompletableFuture<PutDedicatedIpInPoolResponse> putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest) Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the
CreateDedicatedIpPool
operation.- Parameters:
putDedicatedIpInPoolRequest
- A request to move a dedicated IP address to a dedicated IP pool.- Returns:
- A Java Future containing the result of the PutDedicatedIpInPool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDedicatedIpInPool
default CompletableFuture<PutDedicatedIpInPoolResponse> putDedicatedIpInPool(Consumer<PutDedicatedIpInPoolRequest.Builder> putDedicatedIpInPoolRequest) Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the
CreateDedicatedIpPool
operation.
This is a convenience which creates an instance of the
PutDedicatedIpInPoolRequest.Builder
avoiding the need to create one manually viaPutDedicatedIpInPoolRequest.builder()
- Parameters:
putDedicatedIpInPoolRequest
- AConsumer
that will call methods onPutDedicatedIpInPoolRequest.Builder
to create a request. A request to move a dedicated IP address to a dedicated IP pool.- Returns:
- A Java Future containing the result of the PutDedicatedIpInPool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDedicatedIpWarmupAttributes
default CompletableFuture<PutDedicatedIpWarmupAttributesResponse> putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest) - Parameters:
putDedicatedIpWarmupAttributesRequest
- A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.- Returns:
- A Java Future containing the result of the PutDedicatedIpWarmupAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDedicatedIpWarmupAttributes
default CompletableFuture<PutDedicatedIpWarmupAttributesResponse> putDedicatedIpWarmupAttributes(Consumer<PutDedicatedIpWarmupAttributesRequest.Builder> putDedicatedIpWarmupAttributesRequest)
This is a convenience which creates an instance of the
PutDedicatedIpWarmupAttributesRequest.Builder
avoiding the need to create one manually viaPutDedicatedIpWarmupAttributesRequest.builder()
- Parameters:
putDedicatedIpWarmupAttributesRequest
- AConsumer
that will call methods onPutDedicatedIpWarmupAttributesRequest.Builder
to create a request. A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.- Returns:
- A Java Future containing the result of the PutDedicatedIpWarmupAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDeliverabilityDashboardOption
default CompletableFuture<PutDeliverabilityDashboardOptionResponse> putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest) Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Parameters:
putDeliverabilityDashboardOptionRequest
- Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- A Java Future containing the result of the PutDeliverabilityDashboardOption operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource specified in your request already exists.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDeliverabilityDashboardOption
default CompletableFuture<PutDeliverabilityDashboardOptionResponse> putDeliverabilityDashboardOption(Consumer<PutDeliverabilityDashboardOptionRequest.Builder> putDeliverabilityDashboardOptionRequest) Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
This is a convenience which creates an instance of the
PutDeliverabilityDashboardOptionRequest.Builder
avoiding the need to create one manually viaPutDeliverabilityDashboardOptionRequest.builder()
- Parameters:
putDeliverabilityDashboardOptionRequest
- AConsumer
that will call methods onPutDeliverabilityDashboardOptionRequest.Builder
to create a request. Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- A Java Future containing the result of the PutDeliverabilityDashboardOption operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AlreadyExistsException The resource specified in your request already exists.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEmailIdentityDkimAttributes
default CompletableFuture<PutEmailIdentityDkimAttributesResponse> putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest) Used to enable or disable DKIM authentication for an email identity.
- Parameters:
putEmailIdentityDkimAttributesRequest
- A request to enable or disable DKIM signing of email that you send from an email identity.- Returns:
- A Java Future containing the result of the PutEmailIdentityDkimAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEmailIdentityDkimAttributes
default CompletableFuture<PutEmailIdentityDkimAttributesResponse> putEmailIdentityDkimAttributes(Consumer<PutEmailIdentityDkimAttributesRequest.Builder> putEmailIdentityDkimAttributesRequest) Used to enable or disable DKIM authentication for an email identity.
This is a convenience which creates an instance of the
PutEmailIdentityDkimAttributesRequest.Builder
avoiding the need to create one manually viaPutEmailIdentityDkimAttributesRequest.builder()
- Parameters:
putEmailIdentityDkimAttributesRequest
- AConsumer
that will call methods onPutEmailIdentityDkimAttributesRequest.Builder
to create a request. A request to enable or disable DKIM signing of email that you send from an email identity.- Returns:
- A Java Future containing the result of the PutEmailIdentityDkimAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEmailIdentityFeedbackAttributes
default CompletableFuture<PutEmailIdentityFeedbackAttributesResponse> putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest) Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.
When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
- Parameters:
putEmailIdentityFeedbackAttributesRequest
- A request to set the attributes that control how bounce and complaint events are processed.- Returns:
- A Java Future containing the result of the PutEmailIdentityFeedbackAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEmailIdentityFeedbackAttributes
default CompletableFuture<PutEmailIdentityFeedbackAttributesResponse> putEmailIdentityFeedbackAttributes(Consumer<PutEmailIdentityFeedbackAttributesRequest.Builder> putEmailIdentityFeedbackAttributesRequest) Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.
When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
This is a convenience which creates an instance of the
PutEmailIdentityFeedbackAttributesRequest.Builder
avoiding the need to create one manually viaPutEmailIdentityFeedbackAttributesRequest.builder()
- Parameters:
putEmailIdentityFeedbackAttributesRequest
- AConsumer
that will call methods onPutEmailIdentityFeedbackAttributesRequest.Builder
to create a request. A request to set the attributes that control how bounce and complaint events are processed.- Returns:
- A Java Future containing the result of the PutEmailIdentityFeedbackAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEmailIdentityMailFromAttributes
default CompletableFuture<PutEmailIdentityMailFromAttributesResponse> putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest) Used to enable or disable the custom Mail-From domain configuration for an email identity.
- Parameters:
putEmailIdentityMailFromAttributesRequest
- A request to configure the custom MAIL FROM domain for a verified identity.- Returns:
- A Java Future containing the result of the PutEmailIdentityMailFromAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEmailIdentityMailFromAttributes
default CompletableFuture<PutEmailIdentityMailFromAttributesResponse> putEmailIdentityMailFromAttributes(Consumer<PutEmailIdentityMailFromAttributesRequest.Builder> putEmailIdentityMailFromAttributesRequest) Used to enable or disable the custom Mail-From domain configuration for an email identity.
This is a convenience which creates an instance of the
PutEmailIdentityMailFromAttributesRequest.Builder
avoiding the need to create one manually viaPutEmailIdentityMailFromAttributesRequest.builder()
- Parameters:
putEmailIdentityMailFromAttributesRequest
- AConsumer
that will call methods onPutEmailIdentityMailFromAttributesRequest.Builder
to create a request. A request to configure the custom MAIL FROM domain for a verified identity.- Returns:
- A Java Future containing the result of the PutEmailIdentityMailFromAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendEmail
Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:
-
Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.
-
Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
- Parameters:
sendEmailRequest
- A request to send an email message.- Returns:
- A Java Future containing the result of the SendEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- AccountSuspendedException The message can't be sent because the account's ability to send email has been permanently restricted.
- SendingPausedException The message can't be sent because the account's ability to send email is currently paused.
- MessageRejectedException The message can't be sent because it contains invalid content.
- MailFromDomainNotVerifiedException The message can't be sent because the sending domain isn't verified.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
sendEmail
default CompletableFuture<SendEmailResponse> sendEmail(Consumer<SendEmailRequest.Builder> sendEmailRequest) Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:
-
Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.
-
Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
This is a convenience which creates an instance of the
SendEmailRequest.Builder
avoiding the need to create one manually viaSendEmailRequest.builder()
- Parameters:
sendEmailRequest
- AConsumer
that will call methods onSendEmailRequest.Builder
to create a request. A request to send an email message.- Returns:
- A Java Future containing the result of the SendEmail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TooManyRequestsException Too many requests have been made to the operation.
- LimitExceededException There are too many instances of the specified resource type.
- AccountSuspendedException The message can't be sent because the account's ability to send email has been permanently restricted.
- SendingPausedException The message can't be sent because the account's ability to send email is currently paused.
- MessageRejectedException The message can't be sent because it contains invalid content.
- MailFromDomainNotVerifiedException The message can't be sent because the sending domain isn't verified.
- NotFoundException The resource you attempted to access doesn't exist.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
tagResource
Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove one or more tags (keys and values) from a specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input you provided is invalid.
- ConcurrentModificationException The resource is being modified by another operation or thread.
- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetEventDestination
default CompletableFuture<UpdateConfigurationSetEventDestinationResponse> updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) Update the configuration of an event destination for a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
- Parameters:
updateConfigurationSetEventDestinationRequest
- A request to change the settings for an event destination for a configuration set.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationSetEventDestination
default CompletableFuture<UpdateConfigurationSetEventDestinationResponse> updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) Update the configuration of an event destination for a configuration set.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
This is a convenience which creates an instance of the
UpdateConfigurationSetEventDestinationRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationSetEventDestinationRequest.builder()
- Parameters:
updateConfigurationSetEventDestinationRequest
- AConsumer
that will call methods onUpdateConfigurationSetEventDestinationRequest.Builder
to create a request. A request to change the settings for an event destination for a configuration set.- Returns:
- A Java Future containing the result of the UpdateConfigurationSetEventDestination operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException The resource you attempted to access doesn't exist.
- TooManyRequestsException Too many requests have been made to the operation.
- BadRequestException The input you provided is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PinpointEmailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aPinpointEmailAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPinpointEmailAsyncClient
.
-