@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface PinpointEmailClient extends SdkClient
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 PinpointEmailClientBuilder |
builder()
Create a builder that can be used to configure and create a
PinpointEmailClient. |
static PinpointEmailClient |
create()
Create a
PinpointEmailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateConfigurationSetResponse |
createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest)
Create a configuration set.
|
default CreateConfigurationSetResponse |
createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
Create a configuration set.
|
default CreateConfigurationSetEventDestinationResponse |
createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest)
Create an event destination.
|
default CreateConfigurationSetEventDestinationResponse |
createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
Create an event destination.
|
default CreateDedicatedIpPoolResponse |
createDedicatedIpPool(Consumer<CreateDedicatedIpPoolRequest.Builder> createDedicatedIpPoolRequest)
Create a new pool of dedicated IP addresses.
|
default CreateDedicatedIpPoolResponse |
createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest)
Create a new pool of dedicated IP addresses.
|
default CreateDeliverabilityTestReportResponse |
createDeliverabilityTestReport(Consumer<CreateDeliverabilityTestReportRequest.Builder> createDeliverabilityTestReportRequest)
Create a new predictive inbox placement test.
|
default CreateDeliverabilityTestReportResponse |
createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest)
Create a new predictive inbox placement test.
|
default CreateEmailIdentityResponse |
createEmailIdentity(Consumer<CreateEmailIdentityRequest.Builder> createEmailIdentityRequest)
Verifies an email identity for use with Amazon Pinpoint.
|
default CreateEmailIdentityResponse |
createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest)
Verifies an email identity for use with Amazon Pinpoint.
|
default DeleteConfigurationSetResponse |
deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest)
Delete an existing configuration set.
|
default DeleteConfigurationSetResponse |
deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Delete an existing configuration set.
|
default DeleteConfigurationSetEventDestinationResponse |
deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest)
Delete an event destination.
|
default DeleteConfigurationSetEventDestinationResponse |
deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
Delete an event destination.
|
default DeleteDedicatedIpPoolResponse |
deleteDedicatedIpPool(Consumer<DeleteDedicatedIpPoolRequest.Builder> deleteDedicatedIpPoolRequest)
Delete a dedicated IP pool.
|
default DeleteDedicatedIpPoolResponse |
deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest)
Delete a dedicated IP pool.
|
default DeleteEmailIdentityResponse |
deleteEmailIdentity(Consumer<DeleteEmailIdentityRequest.Builder> deleteEmailIdentityRequest)
Deletes an email identity that you previously verified for use with Amazon Pinpoint.
|
default DeleteEmailIdentityResponse |
deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest)
Deletes an email identity that you previously verified for use with Amazon Pinpoint.
|
default GetAccountResponse |
getAccount()
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current
AWS Region.
|
default 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 GetAccountResponse |
getAccount(GetAccountRequest getAccountRequest)
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current
AWS Region.
|
default GetBlacklistReportsResponse |
getBlacklistReports(Consumer<GetBlacklistReportsRequest.Builder> getBlacklistReportsRequest)
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
|
default GetBlacklistReportsResponse |
getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest)
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
|
default 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 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 GetConfigurationSetEventDestinationsResponse |
getConfigurationSetEventDestinations(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest)
Retrieve a list of event destinations that are associated with a configuration set.
|
default GetConfigurationSetEventDestinationsResponse |
getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest)
Retrieve a list of event destinations that are associated with a configuration set.
|
default 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 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 GetDedicatedIpsResponse |
getDedicatedIps(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
|
default GetDedicatedIpsResponse |
getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
|
default GetDedicatedIpsIterable |
getDedicatedIpsPaginator(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
|
default GetDedicatedIpsIterable |
getDedicatedIpsPaginator(GetDedicatedIpsRequest getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
|
default GetDeliverabilityDashboardOptionsResponse |
getDeliverabilityDashboardOptions()
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
|
default GetDeliverabilityDashboardOptionsResponse |
getDeliverabilityDashboardOptions(Consumer<GetDeliverabilityDashboardOptionsRequest.Builder> getDeliverabilityDashboardOptionsRequest)
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
|
default GetDeliverabilityDashboardOptionsResponse |
getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest)
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.
|
default GetDeliverabilityTestReportResponse |
getDeliverabilityTestReport(Consumer<GetDeliverabilityTestReportRequest.Builder> getDeliverabilityTestReportRequest)
Retrieve the results of a predictive inbox placement test.
|
default GetDeliverabilityTestReportResponse |
getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest)
Retrieve the results of a predictive inbox placement test.
|
default GetDomainDeliverabilityCampaignResponse |
getDomainDeliverabilityCampaign(Consumer<GetDomainDeliverabilityCampaignRequest.Builder> getDomainDeliverabilityCampaignRequest)
Retrieve all the deliverability data for a specific campaign.
|
default GetDomainDeliverabilityCampaignResponse |
getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest)
Retrieve all the deliverability data for a specific campaign.
|
default GetDomainStatisticsReportResponse |
getDomainStatisticsReport(Consumer<GetDomainStatisticsReportRequest.Builder> getDomainStatisticsReportRequest)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
|
default GetDomainStatisticsReportResponse |
getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
|
default 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 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 ListConfigurationSetsResponse |
listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest)
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
|
default ListConfigurationSetsResponse |
listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
|
default ListConfigurationSetsIterable |
listConfigurationSetsPaginator(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest)
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
|
default ListConfigurationSetsIterable |
listConfigurationSetsPaginator(ListConfigurationSetsRequest listConfigurationSetsRequest)
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
|
default 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 ListDedicatedIpPoolsResponse |
listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
|
default ListDedicatedIpPoolsIterable |
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 ListDedicatedIpPoolsIterable |
listDedicatedIpPoolsPaginator(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
|
default ListDeliverabilityTestReportsResponse |
listDeliverabilityTestReports(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
default ListDeliverabilityTestReportsResponse |
listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
default ListDeliverabilityTestReportsIterable |
listDeliverabilityTestReportsPaginator(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
default ListDeliverabilityTestReportsIterable |
listDeliverabilityTestReportsPaginator(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
default 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 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 ListDomainDeliverabilityCampaignsIterable |
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 ListDomainDeliverabilityCampaignsIterable |
listDomainDeliverabilityCampaignsPaginator(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest)
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
time range.
|
default ListEmailIdentitiesResponse |
listEmailIdentities(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest)
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.
|
default ListEmailIdentitiesResponse |
listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest)
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.
|
default ListEmailIdentitiesIterable |
listEmailIdentitiesPaginator(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest)
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.
|
default ListEmailIdentitiesIterable |
listEmailIdentitiesPaginator(ListEmailIdentitiesRequest listEmailIdentitiesRequest)
Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Retrieve a list of the tags (keys and values) that are associated with a specified resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieve a list of the tags (keys and values) that are associated with a specified resource.
|
default PutAccountDedicatedIpWarmupAttributesResponse |
putAccountDedicatedIpWarmupAttributes(Consumer<PutAccountDedicatedIpWarmupAttributesRequest.Builder> putAccountDedicatedIpWarmupAttributesRequest)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
|
default PutAccountDedicatedIpWarmupAttributesResponse |
putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
|
default PutAccountSendingAttributesResponse |
putAccountSendingAttributes(Consumer<PutAccountSendingAttributesRequest.Builder> putAccountSendingAttributesRequest)
Enable or disable the ability of your account to send email.
|
default PutAccountSendingAttributesResponse |
putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest)
Enable or disable the ability of your account to send email.
|
default PutConfigurationSetDeliveryOptionsResponse |
putConfigurationSetDeliveryOptions(Consumer<PutConfigurationSetDeliveryOptionsRequest.Builder> putConfigurationSetDeliveryOptionsRequest)
Associate a configuration set with a dedicated IP pool.
|
default PutConfigurationSetDeliveryOptionsResponse |
putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest)
Associate a configuration set with a dedicated IP pool.
|
default 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 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 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 PutConfigurationSetSendingOptionsResponse |
putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest)
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
|
default 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 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 PutDedicatedIpInPoolResponse |
putDedicatedIpInPool(Consumer<PutDedicatedIpInPoolRequest.Builder> putDedicatedIpInPoolRequest)
Move a dedicated IP address to an existing dedicated IP pool.
|
default PutDedicatedIpInPoolResponse |
putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest)
Move a dedicated IP address to an existing dedicated IP pool.
|
default PutDedicatedIpWarmupAttributesResponse |
putDedicatedIpWarmupAttributes(Consumer<PutDedicatedIpWarmupAttributesRequest.Builder> putDedicatedIpWarmupAttributesRequest)
|
default PutDedicatedIpWarmupAttributesResponse |
putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest)
|
default PutDeliverabilityDashboardOptionResponse |
putDeliverabilityDashboardOption(Consumer<PutDeliverabilityDashboardOptionRequest.Builder> putDeliverabilityDashboardOptionRequest)
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.
|
default PutDeliverabilityDashboardOptionResponse |
putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest)
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.
|
default PutEmailIdentityDkimAttributesResponse |
putEmailIdentityDkimAttributes(Consumer<PutEmailIdentityDkimAttributesRequest.Builder> putEmailIdentityDkimAttributesRequest)
Used to enable or disable DKIM authentication for an email identity.
|
default PutEmailIdentityDkimAttributesResponse |
putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest)
Used to enable or disable DKIM authentication for an email identity.
|
default PutEmailIdentityFeedbackAttributesResponse |
putEmailIdentityFeedbackAttributes(Consumer<PutEmailIdentityFeedbackAttributesRequest.Builder> putEmailIdentityFeedbackAttributesRequest)
Used to enable or disable feedback forwarding for an identity.
|
default PutEmailIdentityFeedbackAttributesResponse |
putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest)
Used to enable or disable feedback forwarding for an identity.
|
default PutEmailIdentityMailFromAttributesResponse |
putEmailIdentityMailFromAttributes(Consumer<PutEmailIdentityMailFromAttributesRequest.Builder> putEmailIdentityMailFromAttributesRequest)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
default PutEmailIdentityMailFromAttributesResponse |
putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
default SendEmailResponse |
sendEmail(Consumer<SendEmailRequest.Builder> sendEmailRequest)
Sends an email message.
|
default SendEmailResponse |
sendEmail(SendEmailRequest sendEmailRequest)
Sends an email message.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add one or more tags (keys and values) to a specified resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Add one or more tags (keys and values) to a specified resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove one or more tags (keys and values) from a specified resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Remove one or more tags (keys and values) from a specified resource.
|
default UpdateConfigurationSetEventDestinationResponse |
updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest)
Update the configuration of an event destination for a configuration set.
|
default 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.static PinpointEmailClient create()
PinpointEmailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PinpointEmailClientBuilder builder()
PinpointEmailClient.default CreateConfigurationSetResponse createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) throws AlreadyExistsException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.AlreadyExistsException - The resource specified in your request already exists.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateConfigurationSetResponse createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) throws AlreadyExistsException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.AlreadyExistsException - The resource specified in your request already exists.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest) throws NotFoundException, AlreadyExistsException, LimitExceededException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.AlreadyExistsException - The resource specified in your request already exists.LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest) throws NotFoundException, AlreadyExistsException, LimitExceededException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.AlreadyExistsException - The resource specified in your request already exists.LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDedicatedIpPoolResponse createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest) throws AlreadyExistsException, LimitExceededException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.AlreadyExistsException - The resource specified in your request already exists.LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDedicatedIpPoolResponse createDedicatedIpPool(Consumer<CreateDedicatedIpPoolRequest.Builder> createDedicatedIpPoolRequest) throws AlreadyExistsException, LimitExceededException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.AlreadyExistsException - The resource specified in your request already exists.LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDeliverabilityTestReportResponse createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest) throws AccountSuspendedException, SendingPausedException, MessageRejectedException, MailFromDomainNotVerifiedException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException - The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDeliverabilityTestReportResponse createDeliverabilityTestReport(Consumer<CreateDeliverabilityTestReportRequest.Builder> createDeliverabilityTestReportRequest) throws AccountSuspendedException, SendingPausedException, MessageRejectedException, MailFromDomainNotVerifiedException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException - The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEmailIdentityResponse createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest) throws LimitExceededException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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).LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEmailIdentityResponse createEmailIdentity(Consumer<CreateEmailIdentityRequest.Builder> createEmailIdentityRequest) throws LimitExceededException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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).LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteConfigurationSetResponse deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteConfigurationSetResponse deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDedicatedIpPoolResponse deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
Delete a dedicated IP pool.
deleteDedicatedIpPoolRequest - A request to delete a dedicated IP pool.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDedicatedIpPoolResponse deleteDedicatedIpPool(Consumer<DeleteDedicatedIpPoolRequest.Builder> deleteDedicatedIpPoolRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEmailIdentityResponse deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEmailIdentityResponse deleteEmailIdentity(Consumer<DeleteEmailIdentityRequest.Builder> deleteEmailIdentityRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountResponse getAccount() throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetAccount(GetAccountRequest),
AWS API
Documentationdefault GetAccountResponse getAccount(GetAccountRequest getAccountRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountResponse getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBlacklistReportsResponse getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBlacklistReportsResponse getBlacklistReports(Consumer<GetBlacklistReportsRequest.Builder> getBlacklistReportsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetConfigurationSetResponse getConfigurationSet(GetConfigurationSetRequest getConfigurationSetRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetConfigurationSetResponse getConfigurationSet(Consumer<GetConfigurationSetRequest.Builder> getConfigurationSetRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetConfigurationSetEventDestinationsResponse getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetConfigurationSetEventDestinationsResponse getConfigurationSetEventDestinations(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDedicatedIpResponse getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDedicatedIpResponse getDedicatedIp(Consumer<GetDedicatedIpRequest.Builder> getDedicatedIpRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDedicatedIpsResponse getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
getDedicatedIpsRequest - A request to obtain more information about dedicated IP pools.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDedicatedIpsResponse getDedicatedIps(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDedicatedIpsIterable getDedicatedIpsPaginator(GetDedicatedIpsRequest getDedicatedIpsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client
.getDedicatedIpsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDedicatedIpsIterable getDedicatedIpsPaginator(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client
.getDedicatedIpsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDeliverabilityDashboardOptionsResponse getDeliverabilityDashboardOptions() throws TooManyRequestsException, LimitExceededException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.
TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest),
AWS API Documentationdefault GetDeliverabilityDashboardOptionsResponse getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest) throws TooManyRequestsException, LimitExceededException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.
TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDeliverabilityDashboardOptionsResponse getDeliverabilityDashboardOptions(Consumer<GetDeliverabilityDashboardOptionsRequest.Builder> getDeliverabilityDashboardOptionsRequest) throws TooManyRequestsException, LimitExceededException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.
TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDeliverabilityTestReportResponse getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
Retrieve the results of a predictive inbox placement test.
getDeliverabilityTestReportRequest - A request to retrieve the results of a predictive inbox placement test.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDeliverabilityTestReportResponse getDeliverabilityTestReport(Consumer<GetDeliverabilityTestReportRequest.Builder> getDeliverabilityTestReportRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainDeliverabilityCampaignResponse getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest) throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException
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).TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainDeliverabilityCampaignResponse getDomainDeliverabilityCampaign(Consumer<GetDomainDeliverabilityCampaignRequest.Builder> getDomainDeliverabilityCampaignRequest) throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException
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).TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainStatisticsReportResponse getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainStatisticsReportResponse getDomainStatisticsReport(Consumer<GetDomainStatisticsReportRequest.Builder> getDomainStatisticsReportRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEmailIdentityResponse getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEmailIdentityResponse getEmailIdentity(Consumer<GetEmailIdentityRequest.Builder> getEmailIdentityRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConfigurationSetsResponse listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConfigurationSetsResponse listConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConfigurationSetsIterable listConfigurationSetsPaginator(ListConfigurationSetsRequest listConfigurationSetsRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client
.listConfigurationSetsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConfigurationSetsIterable listConfigurationSetsPaginator(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client
.listConfigurationSetsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDedicatedIpPoolsResponse listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDedicatedIpPoolsResponse listDedicatedIpPools(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDedicatedIpPoolsIterable listDedicatedIpPoolsPaginator(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client
.listDedicatedIpPoolsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDedicatedIpPoolsIterable listDedicatedIpPoolsPaginator(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client
.listDedicatedIpPoolsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeliverabilityTestReportsResponse listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeliverabilityTestReportsResponse listDeliverabilityTestReports(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeliverabilityTestReportsIterable listDeliverabilityTestReportsPaginator(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client
.listDeliverabilityTestReportsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeliverabilityTestReportsIterable listDeliverabilityTestReportsPaginator(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client
.listDeliverabilityTestReportsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainDeliverabilityCampaignsResponse listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainDeliverabilityCampaignsResponse listDomainDeliverabilityCampaigns(Consumer<ListDomainDeliverabilityCampaignsRequest.Builder> listDomainDeliverabilityCampaignsRequest) throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainDeliverabilityCampaignsIterable listDomainDeliverabilityCampaignsPaginator(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client
.listDomainDeliverabilityCampaignsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainDeliverabilityCampaignsIterable listDomainDeliverabilityCampaignsPaginator(Consumer<ListDomainDeliverabilityCampaignsRequest.Builder> listDomainDeliverabilityCampaignsRequest) throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client
.listDomainDeliverabilityCampaignsPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEmailIdentitiesResponse listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEmailIdentitiesResponse listEmailIdentities(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEmailIdentitiesIterable listEmailIdentitiesPaginator(ListEmailIdentitiesRequest listEmailIdentitiesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client
.listEmailIdentitiesPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEmailIdentitiesIterable listEmailIdentitiesPaginator(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client
.listEmailIdentitiesPaginator(request);
for (software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request);
responses.iterator().forEachRemaining(....);
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointEmailException
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 - BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointEmailException
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.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccountDedicatedIpWarmupAttributesResponse putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccountDedicatedIpWarmupAttributesResponse putAccountDedicatedIpWarmupAttributes(Consumer<PutAccountDedicatedIpWarmupAttributesRequest.Builder> putAccountDedicatedIpWarmupAttributesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccountSendingAttributesResponse putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
Enable or disable the ability of your account to send email.
putAccountSendingAttributesRequest - A request to change the ability of your account to send email.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAccountSendingAttributesResponse putAccountSendingAttributes(Consumer<PutAccountSendingAttributesRequest.Builder> putAccountSendingAttributesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutConfigurationSetDeliveryOptionsResponse putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutConfigurationSetDeliveryOptionsResponse putConfigurationSetDeliveryOptions(Consumer<PutConfigurationSetDeliveryOptionsRequest.Builder> putConfigurationSetDeliveryOptionsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutConfigurationSetReputationOptionsResponse putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutConfigurationSetReputationOptionsResponse putConfigurationSetReputationOptions(Consumer<PutConfigurationSetReputationOptionsRequest.Builder> putConfigurationSetReputationOptionsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutConfigurationSetSendingOptionsResponse putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutConfigurationSetSendingOptionsResponse putConfigurationSetSendingOptions(Consumer<PutConfigurationSetSendingOptionsRequest.Builder> putConfigurationSetSendingOptionsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutConfigurationSetTrackingOptionsResponse putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutConfigurationSetTrackingOptionsResponse putConfigurationSetTrackingOptions(Consumer<PutConfigurationSetTrackingOptionsRequest.Builder> putConfigurationSetTrackingOptionsRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDedicatedIpInPoolResponse putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDedicatedIpInPoolResponse putDedicatedIpInPool(Consumer<PutDedicatedIpInPoolRequest.Builder> putDedicatedIpInPoolRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDedicatedIpWarmupAttributesResponse putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDedicatedIpWarmupAttributesResponse putDedicatedIpWarmupAttributes(Consumer<PutDedicatedIpWarmupAttributesRequest.Builder> putDedicatedIpWarmupAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDeliverabilityDashboardOptionResponse putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest) throws AlreadyExistsException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.
AlreadyExistsException - The resource specified in your request already exists.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDeliverabilityDashboardOptionResponse putDeliverabilityDashboardOption(Consumer<PutDeliverabilityDashboardOptionRequest.Builder> putDeliverabilityDashboardOptionRequest) throws AlreadyExistsException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.
AlreadyExistsException - The resource specified in your request already exists.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEmailIdentityDkimAttributesResponse putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEmailIdentityDkimAttributesResponse putEmailIdentityDkimAttributes(Consumer<PutEmailIdentityDkimAttributesRequest.Builder> putEmailIdentityDkimAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEmailIdentityFeedbackAttributesResponse putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEmailIdentityFeedbackAttributesResponse putEmailIdentityFeedbackAttributes(Consumer<PutEmailIdentityFeedbackAttributesRequest.Builder> putEmailIdentityFeedbackAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEmailIdentityMailFromAttributesResponse putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEmailIdentityMailFromAttributesResponse putEmailIdentityMailFromAttributes(Consumer<PutEmailIdentityMailFromAttributesRequest.Builder> putEmailIdentityMailFromAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendEmailResponse sendEmail(SendEmailRequest sendEmailRequest) throws TooManyRequestsException, LimitExceededException, AccountSuspendedException, SendingPausedException, MessageRejectedException, MailFromDomainNotVerifiedException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException - The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendEmailResponse sendEmail(Consumer<SendEmailRequest.Builder> sendEmailRequest) throws TooManyRequestsException, LimitExceededException, AccountSuspendedException, SendingPausedException, MessageRejectedException, MailFromDomainNotVerifiedException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException - The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointEmailException
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 - BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointEmailException
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.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointEmailException
Remove one or more tags (keys and values) from a specified resource.
untagResourceRequest - BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointEmailException
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.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PinpointEmailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.