@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface PinpointEmailAsyncClient extends AwsClient
builder()
method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static PinpointEmailAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
PinpointEmailAsyncClient. |
static PinpointEmailAsyncClient |
create()
Create a
PinpointEmailAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateConfigurationSetResponse> |
createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest)
Create a configuration set.
|
default CompletableFuture<CreateConfigurationSetResponse> |
createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
Create a configuration set.
|
default CompletableFuture<CreateConfigurationSetEventDestinationResponse> |
createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest)
Create an event destination.
|
default CompletableFuture<CreateConfigurationSetEventDestinationResponse> |
createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
Create an event destination.
|
default CompletableFuture<CreateDedicatedIpPoolResponse> |
createDedicatedIpPool(Consumer<CreateDedicatedIpPoolRequest.Builder> createDedicatedIpPoolRequest)
Create a new pool of dedicated IP addresses.
|
default CompletableFuture<CreateDedicatedIpPoolResponse> |
createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest)
Create a new pool of dedicated IP addresses.
|
default CompletableFuture<CreateDeliverabilityTestReportResponse> |
createDeliverabilityTestReport(Consumer<CreateDeliverabilityTestReportRequest.Builder> createDeliverabilityTestReportRequest)
Create a new predictive inbox placement test.
|
default CompletableFuture<CreateDeliverabilityTestReportResponse> |
createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest)
Create a new predictive inbox placement test.
|
default CompletableFuture<CreateEmailIdentityResponse> |
createEmailIdentity(Consumer<CreateEmailIdentityRequest.Builder> createEmailIdentityRequest)
Verifies an email identity for use with Amazon Pinpoint.
|
default CompletableFuture<CreateEmailIdentityResponse> |
createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest)
Verifies an email identity for use with Amazon Pinpoint.
|
default CompletableFuture<DeleteConfigurationSetResponse> |
deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest)
Delete an existing configuration set.
|
default CompletableFuture<DeleteConfigurationSetResponse> |
deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Delete an existing configuration set.
|
default CompletableFuture<DeleteConfigurationSetEventDestinationResponse> |
deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest)
Delete an event destination.
|
default CompletableFuture<DeleteConfigurationSetEventDestinationResponse> |
deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
Delete an event destination.
|
default CompletableFuture<DeleteDedicatedIpPoolResponse> |
deleteDedicatedIpPool(Consumer<DeleteDedicatedIpPoolRequest.Builder> deleteDedicatedIpPoolRequest)
Delete a dedicated IP pool.
|
default CompletableFuture<DeleteDedicatedIpPoolResponse> |
deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest)
Delete a dedicated IP pool.
|
default CompletableFuture<DeleteEmailIdentityResponse> |
deleteEmailIdentity(Consumer<DeleteEmailIdentityRequest.Builder> deleteEmailIdentityRequest)
Deletes an email identity that you previously verified for use with Amazon Pinpoint.
|
default CompletableFuture<DeleteEmailIdentityResponse> |
deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest)
Deletes an email identity that you previously verified for use with Amazon Pinpoint.
|
default CompletableFuture<GetAccountResponse> |
getAccount()
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.
|
default CompletableFuture<GetBlacklistReportsResponse> |
getBlacklistReports(Consumer<GetBlacklistReportsRequest.Builder> getBlacklistReportsRequest)
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
|
default CompletableFuture<GetBlacklistReportsResponse> |
getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest)
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
|
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.
|
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.
|
default CompletableFuture<GetConfigurationSetEventDestinationsResponse> |
getConfigurationSetEventDestinations(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest)
Retrieve a list of event destinations that are associated with a configuration set.
|
default CompletableFuture<GetConfigurationSetEventDestinationsResponse> |
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)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
|
default GetDedicatedIpsPublisher |
getDedicatedIpsPaginator(GetDedicatedIpsRequest getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
|
default CompletableFuture<GetDeliverabilityDashboardOptionsResponse> |
getDeliverabilityDashboardOptions()
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
|
default CompletableFuture<GetDeliverabilityDashboardOptionsResponse> |
getDeliverabilityDashboardOptions(Consumer<GetDeliverabilityDashboardOptionsRequest.Builder> getDeliverabilityDashboardOptionsRequest)
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
|
default CompletableFuture<GetDeliverabilityDashboardOptionsResponse> |
getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest)
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
|
default CompletableFuture<GetDeliverabilityTestReportResponse> |
getDeliverabilityTestReport(Consumer<GetDeliverabilityTestReportRequest.Builder> getDeliverabilityTestReportRequest)
Retrieve the results of a predictive inbox placement test.
|
default CompletableFuture<GetDeliverabilityTestReportResponse> |
getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest)
Retrieve the results of a predictive inbox placement test.
|
default CompletableFuture<GetDomainDeliverabilityCampaignResponse> |
getDomainDeliverabilityCampaign(Consumer<GetDomainDeliverabilityCampaignRequest.Builder> getDomainDeliverabilityCampaignRequest)
Retrieve all the deliverability data for a specific campaign.
|
default CompletableFuture<GetDomainDeliverabilityCampaignResponse> |
getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest)
Retrieve all the deliverability data for a specific campaign.
|
default CompletableFuture<GetDomainStatisticsReportResponse> |
getDomainStatisticsReport(Consumer<GetDomainStatisticsReportRequest.Builder> getDomainStatisticsReportRequest)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
|
default CompletableFuture<GetDomainStatisticsReportResponse> |
getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
|
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.
|
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.
|
default CompletableFuture<ListConfigurationSetsResponse> |
listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest)
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
|
default CompletableFuture<ListConfigurationSetsResponse> |
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)
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
|
default ListConfigurationSetsPublisher |
listConfigurationSetsPaginator(ListConfigurationSetsRequest listConfigurationSetsRequest)
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
|
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.
|
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.
|
default ListDedicatedIpPoolsPublisher |
listDedicatedIpPoolsPaginator(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest)
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
|
default ListDedicatedIpPoolsPublisher |
listDedicatedIpPoolsPaginator(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
|
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.
|
default CompletableFuture<ListDeliverabilityTestReportsResponse> |
listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
default ListDeliverabilityTestReportsPublisher |
listDeliverabilityTestReportsPaginator(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
default ListDeliverabilityTestReportsPublisher |
listDeliverabilityTestReportsPaginator(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
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.
|
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.
|
default ListDomainDeliverabilityCampaignsPublisher |
listDomainDeliverabilityCampaignsPaginator(Consumer<ListDomainDeliverabilityCampaignsRequest.Builder> listDomainDeliverabilityCampaignsRequest)
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
time range.
|
default ListDomainDeliverabilityCampaignsPublisher |
listDomainDeliverabilityCampaignsPaginator(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest)
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
time range.
|
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.
|
default CompletableFuture<ListEmailIdentitiesResponse> |
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)
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.
|
default ListEmailIdentitiesPublisher |
listEmailIdentitiesPaginator(ListEmailIdentitiesRequest listEmailIdentitiesRequest)
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Retrieve a list of the tags (keys and values) that are associated with a specified resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieve a list of the tags (keys and values) that are associated with a specified resource.
|
default CompletableFuture<PutAccountDedicatedIpWarmupAttributesResponse> |
putAccountDedicatedIpWarmupAttributes(Consumer<PutAccountDedicatedIpWarmupAttributesRequest.Builder> putAccountDedicatedIpWarmupAttributesRequest)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
|
default CompletableFuture<PutAccountDedicatedIpWarmupAttributesResponse> |
putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
|
default CompletableFuture<PutAccountSendingAttributesResponse> |
putAccountSendingAttributes(Consumer<PutAccountSendingAttributesRequest.Builder> putAccountSendingAttributesRequest)
Enable or disable the ability of your account to send email.
|
default CompletableFuture<PutAccountSendingAttributesResponse> |
putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest)
Enable or disable the ability of your account to send email.
|
default CompletableFuture<PutConfigurationSetDeliveryOptionsResponse> |
putConfigurationSetDeliveryOptions(Consumer<PutConfigurationSetDeliveryOptionsRequest.Builder> putConfigurationSetDeliveryOptionsRequest)
Associate a configuration set with a dedicated IP pool.
|
default CompletableFuture<PutConfigurationSetDeliveryOptionsResponse> |
putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest)
Associate a configuration set with a dedicated IP pool.
|
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.
|
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.
|
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.
|
default CompletableFuture<PutConfigurationSetSendingOptionsResponse> |
putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest)
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
|
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.
|
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.
|
default CompletableFuture<PutDedicatedIpInPoolResponse> |
putDedicatedIpInPool(Consumer<PutDedicatedIpInPoolRequest.Builder> putDedicatedIpInPoolRequest)
Move a dedicated IP address to an existing dedicated IP pool.
|
default CompletableFuture<PutDedicatedIpInPoolResponse> |
putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest)
Move a dedicated IP address to an existing dedicated IP pool.
|
default CompletableFuture<PutDedicatedIpWarmupAttributesResponse> |
putDedicatedIpWarmupAttributes(Consumer<PutDedicatedIpWarmupAttributesRequest.Builder> putDedicatedIpWarmupAttributesRequest)
|
default CompletableFuture<PutDedicatedIpWarmupAttributesResponse> |
putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest)
|
default CompletableFuture<PutDeliverabilityDashboardOptionResponse> |
putDeliverabilityDashboardOption(Consumer<PutDeliverabilityDashboardOptionRequest.Builder> putDeliverabilityDashboardOptionRequest)
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.
|
default CompletableFuture<PutDeliverabilityDashboardOptionResponse> |
putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest)
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.
|
default CompletableFuture<PutEmailIdentityDkimAttributesResponse> |
putEmailIdentityDkimAttributes(Consumer<PutEmailIdentityDkimAttributesRequest.Builder> putEmailIdentityDkimAttributesRequest)
Used to enable or disable DKIM authentication for an email identity.
|
default CompletableFuture<PutEmailIdentityDkimAttributesResponse> |
putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest)
Used to enable or disable DKIM authentication for an email identity.
|
default CompletableFuture<PutEmailIdentityFeedbackAttributesResponse> |
putEmailIdentityFeedbackAttributes(Consumer<PutEmailIdentityFeedbackAttributesRequest.Builder> putEmailIdentityFeedbackAttributesRequest)
Used to enable or disable feedback forwarding for an identity.
|
default CompletableFuture<PutEmailIdentityFeedbackAttributesResponse> |
putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest)
Used to enable or disable feedback forwarding for an identity.
|
default CompletableFuture<PutEmailIdentityMailFromAttributesResponse> |
putEmailIdentityMailFromAttributes(Consumer<PutEmailIdentityMailFromAttributesRequest.Builder> putEmailIdentityMailFromAttributesRequest)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
default CompletableFuture<PutEmailIdentityMailFromAttributesResponse> |
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.
|
default PinpointEmailServiceClientConfiguration |
serviceClientConfiguration() |
default 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.
|
default CompletableFuture<UpdateConfigurationSetEventDestinationResponse> |
updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest)
Update the configuration of an event destination for a configuration set.
|
default CompletableFuture<UpdateConfigurationSetEventDestinationResponse> |
updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
Update the configuration of an event destination for a configuration set.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
createConfigurationSetRequest - A request to create a configuration set.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 via CreateConfigurationSetRequest.builder()
createConfigurationSetRequest - A Consumer that will call methods on
CreateConfigurationSetRequest.Builder to
create a request. A request to create a configuration set.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.
createConfigurationSetEventDestinationRequest - A request to add an event destination to a configuration set.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 via
CreateConfigurationSetEventDestinationRequest.builder()
createConfigurationSetEventDestinationRequest - A Consumer that will call methods on
CreateConfigurationSetEventDestinationRequest.Builder
to create a request. A request to add an event destination to a configuration set.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.
createDedicatedIpPoolRequest - A request to create a new dedicated IP pool.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 via CreateDedicatedIpPoolRequest.builder()
createDedicatedIpPoolRequest - A Consumer that will call methods on
CreateDedicatedIpPoolRequest.Builder to create
a request. A request to create a new dedicated IP pool.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.
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 the
GetDeliverabilityTestReport operation to view the results of the test.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 via CreateDeliverabilityTestReportRequest.builder()
createDeliverabilityTestReportRequest - A Consumer that will call methods on
CreateDeliverabilityTestReportRequest.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 the GetDeliverabilityTestReport operation to view the results of the test.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.
createEmailIdentityRequest - A request to begin the verification process for an email identity (an email address or domain).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 via CreateEmailIdentityRequest.builder()
createEmailIdentityRequest - A Consumer that will call methods on
CreateEmailIdentityRequest.Builder to create a
request. A request to begin the verification process for an email identity (an email address or domain).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.
deleteConfigurationSetRequest - A request to delete a configuration set.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 via DeleteConfigurationSetRequest.builder()
deleteConfigurationSetRequest - A Consumer that will call methods on
DeleteConfigurationSetRequest.Builder to
create a request. A request to delete a configuration set.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.
deleteConfigurationSetEventDestinationRequest - A request to delete an event destination from a configuration set.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 via
DeleteConfigurationSetEventDestinationRequest.builder()
deleteConfigurationSetEventDestinationRequest - A Consumer that will call methods on
DeleteConfigurationSetEventDestinationRequest.Builder
to create a request. A request to delete an event destination from a configuration set.default CompletableFuture<DeleteDedicatedIpPoolResponse> deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest)
Delete a dedicated IP pool.
deleteDedicatedIpPoolRequest - A request to delete a dedicated IP pool.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 via DeleteDedicatedIpPoolRequest.builder()
deleteDedicatedIpPoolRequest - A Consumer that will call methods on
DeleteDedicatedIpPoolRequest.Builder to create
a request. A request to delete a dedicated IP pool.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.
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.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 via DeleteEmailIdentityRequest.builder()
deleteEmailIdentityRequest - A Consumer that will call methods on
DeleteEmailIdentityRequest.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.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.
getAccountRequest - A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.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 via GetAccountRequest.builder()
getAccountRequest - A Consumer that will call methods on
GetAccountRequest.Builder to create a request.
A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.default CompletableFuture<GetAccountResponse> getAccount()
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
default CompletableFuture<GetBlacklistReportsResponse> getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest)
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
getBlacklistReportsRequest - A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.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 via GetBlacklistReportsRequest.builder()
getBlacklistReportsRequest - A Consumer that will call methods on
GetBlacklistReportsRequest.Builder to create a
request. A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.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.
getConfigurationSetRequest - A request to obtain information about a configuration set.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 via GetConfigurationSetRequest.builder()
getConfigurationSetRequest - A Consumer that will call methods on
GetConfigurationSetRequest.Builder to create a
request. A request to obtain information about a configuration set.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.
getConfigurationSetEventDestinationsRequest - A request to obtain information about the event destinations for a configuration set.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 via
GetConfigurationSetEventDestinationsRequest.builder()
getConfigurationSetEventDestinationsRequest - A Consumer that will call methods on
GetConfigurationSetEventDestinationsRequest.Builder
to create a request. A request to obtain information about the event destinations for a configuration set.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.
getDedicatedIpRequest - A request to obtain more information about a dedicated IP address.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 via GetDedicatedIpRequest.builder()
getDedicatedIpRequest - A Consumer that will call methods on
GetDedicatedIpRequest.Builder to create a
request. A request to obtain more information about a dedicated IP address.default CompletableFuture<GetDedicatedIpsResponse> getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
getDedicatedIpsRequest - A request to obtain more information about dedicated IP pools.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 via GetDedicatedIpsRequest.builder()
getDedicatedIpsRequest - A Consumer that will call methods on
GetDedicatedIpsRequest.Builder to create a
request. A request to obtain more information about dedicated IP pools.default GetDedicatedIpsPublisher getDedicatedIpsPaginator(GetDedicatedIpsRequest getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsPublisher publisher = client.getDedicatedIpsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
getDedicatedIpsRequest - A request to obtain more information about dedicated IP pools.default GetDedicatedIpsPublisher getDedicatedIpsPaginator(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsPublisher publisher = client.getDedicatedIpsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via GetDedicatedIpsRequest.builder()
getDedicatedIpsRequest - A Consumer that will call methods on
GetDedicatedIpsRequest.Builder to create a
request. A request to obtain more information about dedicated IP pools.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.
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.
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 via GetDeliverabilityDashboardOptionsRequest.builder()
getDeliverabilityDashboardOptionsRequest - A Consumer that will call methods on
GetDeliverabilityDashboardOptionsRequest.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.
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.
default CompletableFuture<GetDeliverabilityTestReportResponse> getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest)
Retrieve the results of a predictive inbox placement test.
getDeliverabilityTestReportRequest - A request to retrieve the results of a predictive inbox placement test.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 via GetDeliverabilityTestReportRequest.builder()
getDeliverabilityTestReportRequest - A Consumer that will call methods on
GetDeliverabilityTestReportRequest.Builder to
create a request. A request to retrieve the results of a predictive inbox placement test.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).
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).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 via GetDomainDeliverabilityCampaignRequest.builder()
getDomainDeliverabilityCampaignRequest - A Consumer that will call methods on
GetDomainDeliverabilityCampaignRequest.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).default CompletableFuture<GetDomainStatisticsReportResponse> getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
getDomainStatisticsReportRequest - A request to obtain deliverability metrics for a domain.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 via GetDomainStatisticsReportRequest.builder()
getDomainStatisticsReportRequest - A Consumer that will call methods on
GetDomainStatisticsReportRequest.Builder to
create a request. A request to obtain deliverability metrics for a domain.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.
getEmailIdentityRequest - A request to return details about an email identity.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 via GetEmailIdentityRequest.builder()
getEmailIdentityRequest - A Consumer that will call methods on
GetEmailIdentityRequest.Builder to create a
request. A request to return details about an email identity.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.
listConfigurationSetsRequest - A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS
Region.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 via ListConfigurationSetsRequest.builder()
listConfigurationSetsRequest - A Consumer that will call methods on
ListConfigurationSetsRequest.Builder to create
a request. A request to obtain a list of configuration sets for your Amazon Pinpoint account in the
current AWS Region.default ListConfigurationSetsPublisher listConfigurationSetsPaginator(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.
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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsPublisher publisher = client.listConfigurationSetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listConfigurationSetsRequest - A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS
Region.default ListConfigurationSetsPublisher listConfigurationSetsPaginator(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 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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsPublisher publisher = client.listConfigurationSetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListConfigurationSetsRequest.builder()
listConfigurationSetsRequest - A Consumer that will call methods on
ListConfigurationSetsRequest.Builder to create
a request. A request to obtain a list of configuration sets for your Amazon Pinpoint account in the
current AWS Region.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.
listDedicatedIpPoolsRequest - A request to obtain a list of dedicated IP pools.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 via ListDedicatedIpPoolsRequest.builder()
listDedicatedIpPoolsRequest - A Consumer that will call methods on
ListDedicatedIpPoolsRequest.Builder to create
a request. A request to obtain a list of dedicated IP pools.default ListDedicatedIpPoolsPublisher listDedicatedIpPoolsPaginator(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsPublisher publisher = client.listDedicatedIpPoolsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listDedicatedIpPoolsRequest - A request to obtain a list of dedicated IP pools.default ListDedicatedIpPoolsPublisher listDedicatedIpPoolsPaginator(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 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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsPublisher publisher = client.listDedicatedIpPoolsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListDedicatedIpPoolsRequest.builder()
listDedicatedIpPoolsRequest - A Consumer that will call methods on
ListDedicatedIpPoolsRequest.Builder to create
a request. A request to obtain a list of dedicated IP pools.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.
listDeliverabilityTestReportsRequest - A request to list all of the predictive inbox placement tests that you've performed.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 via ListDeliverabilityTestReportsRequest.builder()
listDeliverabilityTestReportsRequest - A Consumer that will call methods on
ListDeliverabilityTestReportsRequest.Builder
to create a request. A request to list all of the predictive inbox placement tests that you've performed.default ListDeliverabilityTestReportsPublisher listDeliverabilityTestReportsPaginator(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.
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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsPublisher publisher = client.listDeliverabilityTestReportsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listDeliverabilityTestReportsRequest - A request to list all of the predictive inbox placement tests that you've performed.default ListDeliverabilityTestReportsPublisher listDeliverabilityTestReportsPaginator(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 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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsPublisher publisher = client.listDeliverabilityTestReportsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListDeliverabilityTestReportsRequest.builder()
listDeliverabilityTestReportsRequest - A Consumer that will call methods on
ListDeliverabilityTestReportsRequest.Builder
to create a request. A request to list all of the predictive inbox placement tests that you've performed.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.
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.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 via ListDomainDeliverabilityCampaignsRequest.builder()
listDomainDeliverabilityCampaignsRequest - A Consumer that will call methods on
ListDomainDeliverabilityCampaignsRequest.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.default ListDomainDeliverabilityCampaignsPublisher listDomainDeliverabilityCampaignsPaginator(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.
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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsPublisher publisher = client.listDomainDeliverabilityCampaignsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
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.default ListDomainDeliverabilityCampaignsPublisher listDomainDeliverabilityCampaignsPaginator(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 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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsPublisher publisher = client.listDomainDeliverabilityCampaignsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListDomainDeliverabilityCampaignsRequest.builder()
listDomainDeliverabilityCampaignsRequest - A Consumer that will call methods on
ListDomainDeliverabilityCampaignsRequest.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.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.
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.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 via ListEmailIdentitiesRequest.builder()
listEmailIdentitiesRequest - A Consumer that will call methods on
ListEmailIdentitiesRequest.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.default ListEmailIdentitiesPublisher listEmailIdentitiesPaginator(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.
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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesPublisher publisher = client.listEmailIdentitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
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.default ListEmailIdentitiesPublisher listEmailIdentitiesPaginator(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 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 new Subscription 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 method
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesPublisher publisher = client.listEmailIdentitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListEmailIdentitiesRequest.builder()
listEmailIdentitiesRequest - A Consumer that will call methods on
ListEmailIdentitiesRequest.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.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.
listTagsForResourceRequest - 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<PutAccountDedicatedIpWarmupAttributesResponse> putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDedicatedIpWarmupAttributesRequest - A request to enable or disable the automatic IP address warm-up feature.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 via
PutAccountDedicatedIpWarmupAttributesRequest.builder()
putAccountDedicatedIpWarmupAttributesRequest - A Consumer that will call methods on
PutAccountDedicatedIpWarmupAttributesRequest.Builder
to create a request. A request to enable or disable the automatic IP address warm-up feature.default CompletableFuture<PutAccountSendingAttributesResponse> putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest)
Enable or disable the ability of your account to send email.
putAccountSendingAttributesRequest - A request to change the ability of your account to send email.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 via PutAccountSendingAttributesRequest.builder()
putAccountSendingAttributesRequest - A Consumer that will call methods on
PutAccountSendingAttributesRequest.Builder to
create a request. A request to change the ability of your account to send email.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.
putConfigurationSetDeliveryOptionsRequest - A request to associate a configuration set with a dedicated IP pool.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 via PutConfigurationSetDeliveryOptionsRequest.builder()
putConfigurationSetDeliveryOptionsRequest - A Consumer that will call methods on
PutConfigurationSetDeliveryOptionsRequest.Builder
to create a request. A request to associate a configuration set with a dedicated IP pool.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.
putConfigurationSetReputationOptionsRequest - A request to enable or disable tracking of reputation metrics for a configuration set.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 via
PutConfigurationSetReputationOptionsRequest.builder()
putConfigurationSetReputationOptionsRequest - A Consumer that will call methods on
PutConfigurationSetReputationOptionsRequest.Builder
to create a request. A request to enable or disable tracking of reputation metrics for a configuration
set.default CompletableFuture<PutConfigurationSetSendingOptionsResponse> putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest)
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
putConfigurationSetSendingOptionsRequest - A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific
configuration set.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 via PutConfigurationSetSendingOptionsRequest.builder()
putConfigurationSetSendingOptionsRequest - A Consumer that will call methods on
PutConfigurationSetSendingOptionsRequest.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.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.
putConfigurationSetTrackingOptionsRequest - A request to add a custom domain for tracking open and click events to a configuration set.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 via PutConfigurationSetTrackingOptionsRequest.builder()
putConfigurationSetTrackingOptionsRequest - A Consumer that will call methods on
PutConfigurationSetTrackingOptionsRequest.Builder
to create a request. A request to add a custom domain for tracking open and click events to a
configuration set.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.
putDedicatedIpInPoolRequest - A request to move a dedicated IP address to a dedicated IP pool.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 via PutDedicatedIpInPoolRequest.builder()
putDedicatedIpInPoolRequest - A Consumer that will call methods on
PutDedicatedIpInPoolRequest.Builder to create
a request. A request to move a dedicated IP address to a dedicated IP pool.default CompletableFuture<PutDedicatedIpWarmupAttributesResponse> putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest)
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.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 via PutDedicatedIpWarmupAttributesRequest.builder()
putDedicatedIpWarmupAttributesRequest - A Consumer that will call methods on
PutDedicatedIpWarmupAttributesRequest.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.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.
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.
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 via PutDeliverabilityDashboardOptionRequest.builder()
putDeliverabilityDashboardOptionRequest - A Consumer that will call methods on
PutDeliverabilityDashboardOptionRequest.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.
default CompletableFuture<PutEmailIdentityDkimAttributesResponse> putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest)
Used to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimAttributesRequest - A request to enable or disable DKIM signing of email that you send from an email identity.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 via PutEmailIdentityDkimAttributesRequest.builder()
putEmailIdentityDkimAttributesRequest - A Consumer that will call methods on
PutEmailIdentityDkimAttributesRequest.Builder
to create a request. A request to enable or disable DKIM signing of email that you send from an email
identity.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).
putEmailIdentityFeedbackAttributesRequest - A request to set the attributes that control how bounce and complaint events are processed.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 via PutEmailIdentityFeedbackAttributesRequest.builder()
putEmailIdentityFeedbackAttributesRequest - A Consumer that will call methods on
PutEmailIdentityFeedbackAttributesRequest.Builder
to create a request. A request to set the attributes that control how bounce and complaint events are
processed.default CompletableFuture<PutEmailIdentityMailFromAttributesResponse> putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
putEmailIdentityMailFromAttributesRequest - A request to configure the custom MAIL FROM domain for a verified identity.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 via PutEmailIdentityMailFromAttributesRequest.builder()
putEmailIdentityMailFromAttributesRequest - A Consumer that will call methods on
PutEmailIdentityMailFromAttributesRequest.Builder
to create a request. A request to configure the custom MAIL FROM domain for a verified identity.default CompletableFuture<SendEmailResponse> sendEmail(SendEmailRequest 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.
sendEmailRequest - A request to send an email message.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 via SendEmailRequest.builder()
sendEmailRequest - A Consumer that will call methods on
SendEmailRequest.Builder to create a request.
A request to send an email message.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest 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.
tagResourceRequest - 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Remove one or more tags (keys and values) from a specified resource.
untagResourceRequest - 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.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.
updateConfigurationSetEventDestinationRequest - A request to change the settings for an event destination for a configuration set.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 via
UpdateConfigurationSetEventDestinationRequest.builder()
updateConfigurationSetEventDestinationRequest - A Consumer that will call methods on
UpdateConfigurationSetEventDestinationRequest.Builder
to create a request. A request to change the settings for an event destination for a configuration set.default PinpointEmailServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic PinpointEmailAsyncClient create()
PinpointEmailAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PinpointEmailAsyncClientBuilder builder()
PinpointEmailAsyncClient.Copyright © 2023. All rights reserved.