Interface PinpointEmailClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PinpointEmailClient extends AwsClient
Service client for accessing Pinpoint Email. This can be created using the staticbuilder()method.Amazon Pinpoint Email Service Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.
Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static PinpointEmailClientBuilderbuilder()Create a builder that can be used to configure and create aPinpointEmailClient.static PinpointEmailClientcreate()Create aPinpointEmailClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateConfigurationSetResponsecreateConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest)Create a configuration set.default CreateConfigurationSetResponsecreateConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)Create a configuration set.default CreateConfigurationSetEventDestinationResponsecreateConfigurationSetEventDestination(Consumer<CreateConfigurationSetEventDestinationRequest.Builder> createConfigurationSetEventDestinationRequest)Create an event destination.default CreateConfigurationSetEventDestinationResponsecreateConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)Create an event destination.default CreateDedicatedIpPoolResponsecreateDedicatedIpPool(Consumer<CreateDedicatedIpPoolRequest.Builder> createDedicatedIpPoolRequest)Create a new pool of dedicated IP addresses.default CreateDedicatedIpPoolResponsecreateDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest)Create a new pool of dedicated IP addresses.default CreateDeliverabilityTestReportResponsecreateDeliverabilityTestReport(Consumer<CreateDeliverabilityTestReportRequest.Builder> createDeliverabilityTestReportRequest)Create a new predictive inbox placement test.default CreateDeliverabilityTestReportResponsecreateDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest)Create a new predictive inbox placement test.default CreateEmailIdentityResponsecreateEmailIdentity(Consumer<CreateEmailIdentityRequest.Builder> createEmailIdentityRequest)Verifies an email identity for use with Amazon Pinpoint.default CreateEmailIdentityResponsecreateEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest)Verifies an email identity for use with Amazon Pinpoint.default DeleteConfigurationSetResponsedeleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest)Delete an existing configuration set.default DeleteConfigurationSetResponsedeleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)Delete an existing configuration set.default DeleteConfigurationSetEventDestinationResponsedeleteConfigurationSetEventDestination(Consumer<DeleteConfigurationSetEventDestinationRequest.Builder> deleteConfigurationSetEventDestinationRequest)Delete an event destination.default DeleteConfigurationSetEventDestinationResponsedeleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)Delete an event destination.default DeleteDedicatedIpPoolResponsedeleteDedicatedIpPool(Consumer<DeleteDedicatedIpPoolRequest.Builder> deleteDedicatedIpPoolRequest)Delete a dedicated IP pool.default DeleteDedicatedIpPoolResponsedeleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest)Delete a dedicated IP pool.default DeleteEmailIdentityResponsedeleteEmailIdentity(Consumer<DeleteEmailIdentityRequest.Builder> deleteEmailIdentityRequest)Deletes an email identity that you previously verified for use with Amazon Pinpoint.default DeleteEmailIdentityResponsedeleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest)Deletes an email identity that you previously verified for use with Amazon Pinpoint.default GetAccountResponsegetAccount()Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.default GetAccountResponsegetAccount(Consumer<GetAccountRequest.Builder> getAccountRequest)Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.default GetAccountResponsegetAccount(GetAccountRequest getAccountRequest)Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.default GetBlacklistReportsResponsegetBlacklistReports(Consumer<GetBlacklistReportsRequest.Builder> getBlacklistReportsRequest)Retrieve a list of the blacklists that your dedicated IP addresses appear on.default GetBlacklistReportsResponsegetBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest)Retrieve a list of the blacklists that your dedicated IP addresses appear on.default GetConfigurationSetResponsegetConfigurationSet(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 GetConfigurationSetResponsegetConfigurationSet(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 GetConfigurationSetEventDestinationsResponsegetConfigurationSetEventDestinations(Consumer<GetConfigurationSetEventDestinationsRequest.Builder> getConfigurationSetEventDestinationsRequest)Retrieve a list of event destinations that are associated with a configuration set.default GetConfigurationSetEventDestinationsResponsegetConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest)Retrieve a list of event destinations that are associated with a configuration set.default GetDedicatedIpResponsegetDedicatedIp(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 GetDedicatedIpResponsegetDedicatedIp(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 GetDedicatedIpsResponsegetDedicatedIps(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest)List the dedicated IP addresses that are associated with your Amazon Pinpoint account.default GetDedicatedIpsResponsegetDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest)List the dedicated IP addresses that are associated with your Amazon Pinpoint account.default GetDedicatedIpsIterablegetDedicatedIpsPaginator(Consumer<GetDedicatedIpsRequest.Builder> getDedicatedIpsRequest)List the dedicated IP addresses that are associated with your Amazon Pinpoint account.default GetDedicatedIpsIterablegetDedicatedIpsPaginator(GetDedicatedIpsRequest getDedicatedIpsRequest)List the dedicated IP addresses that are associated with your Amazon Pinpoint account.default GetDeliverabilityDashboardOptionsResponsegetDeliverabilityDashboardOptions()Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.default GetDeliverabilityDashboardOptionsResponsegetDeliverabilityDashboardOptions(Consumer<GetDeliverabilityDashboardOptionsRequest.Builder> getDeliverabilityDashboardOptionsRequest)Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.default GetDeliverabilityDashboardOptionsResponsegetDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest)Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.default GetDeliverabilityTestReportResponsegetDeliverabilityTestReport(Consumer<GetDeliverabilityTestReportRequest.Builder> getDeliverabilityTestReportRequest)Retrieve the results of a predictive inbox placement test.default GetDeliverabilityTestReportResponsegetDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest)Retrieve the results of a predictive inbox placement test.default GetDomainDeliverabilityCampaignResponsegetDomainDeliverabilityCampaign(Consumer<GetDomainDeliverabilityCampaignRequest.Builder> getDomainDeliverabilityCampaignRequest)Retrieve all the deliverability data for a specific campaign.default GetDomainDeliverabilityCampaignResponsegetDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest)Retrieve all the deliverability data for a specific campaign.default GetDomainStatisticsReportResponsegetDomainStatisticsReport(Consumer<GetDomainStatisticsReportRequest.Builder> getDomainStatisticsReportRequest)Retrieve inbox placement and engagement rates for the domains that you use to send email.default GetDomainStatisticsReportResponsegetDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest)Retrieve inbox placement and engagement rates for the domains that you use to send email.default GetEmailIdentityResponsegetEmailIdentity(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 GetEmailIdentityResponsegetEmailIdentity(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 ListConfigurationSetsResponselistConfigurationSets(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest)List all of the configuration sets associated with your Amazon Pinpoint account in the current region.default ListConfigurationSetsResponselistConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)List all of the configuration sets associated with your Amazon Pinpoint account in the current region.default ListConfigurationSetsIterablelistConfigurationSetsPaginator(Consumer<ListConfigurationSetsRequest.Builder> listConfigurationSetsRequest)List all of the configuration sets associated with your Amazon Pinpoint account in the current region.default ListConfigurationSetsIterablelistConfigurationSetsPaginator(ListConfigurationSetsRequest listConfigurationSetsRequest)List all of the configuration sets associated with your Amazon Pinpoint account in the current region.default ListDedicatedIpPoolsResponselistDedicatedIpPools(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest)List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.default ListDedicatedIpPoolsResponselistDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.default ListDedicatedIpPoolsIterablelistDedicatedIpPoolsPaginator(Consumer<ListDedicatedIpPoolsRequest.Builder> listDedicatedIpPoolsRequest)List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.default ListDedicatedIpPoolsIterablelistDedicatedIpPoolsPaginator(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.default ListDeliverabilityTestReportsResponselistDeliverabilityTestReports(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest)Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.default ListDeliverabilityTestReportsResponselistDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.default ListDeliverabilityTestReportsIterablelistDeliverabilityTestReportsPaginator(Consumer<ListDeliverabilityTestReportsRequest.Builder> listDeliverabilityTestReportsRequest)Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.default ListDeliverabilityTestReportsIterablelistDeliverabilityTestReportsPaginator(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.default ListDomainDeliverabilityCampaignsResponselistDomainDeliverabilityCampaigns(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 ListDomainDeliverabilityCampaignsResponselistDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest)Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.default ListDomainDeliverabilityCampaignsIterablelistDomainDeliverabilityCampaignsPaginator(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 ListDomainDeliverabilityCampaignsIterablelistDomainDeliverabilityCampaignsPaginator(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest)Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.default ListEmailIdentitiesResponselistEmailIdentities(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest)Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.default ListEmailIdentitiesResponselistEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest)Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.default ListEmailIdentitiesIterablelistEmailIdentitiesPaginator(Consumer<ListEmailIdentitiesRequest.Builder> listEmailIdentitiesRequest)Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.default ListEmailIdentitiesIterablelistEmailIdentitiesPaginator(ListEmailIdentitiesRequest listEmailIdentitiesRequest)Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Retrieve a list of the tags (keys and values) that are associated with a specified resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Retrieve a list of the tags (keys and values) that are associated with a specified resource.default PutAccountDedicatedIpWarmupAttributesResponseputAccountDedicatedIpWarmupAttributes(Consumer<PutAccountDedicatedIpWarmupAttributesRequest.Builder> putAccountDedicatedIpWarmupAttributesRequest)Enable or disable the automatic warm-up feature for dedicated IP addresses.default PutAccountDedicatedIpWarmupAttributesResponseputAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest)Enable or disable the automatic warm-up feature for dedicated IP addresses.default PutAccountSendingAttributesResponseputAccountSendingAttributes(Consumer<PutAccountSendingAttributesRequest.Builder> putAccountSendingAttributesRequest)Enable or disable the ability of your account to send email.default PutAccountSendingAttributesResponseputAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest)Enable or disable the ability of your account to send email.default PutConfigurationSetDeliveryOptionsResponseputConfigurationSetDeliveryOptions(Consumer<PutConfigurationSetDeliveryOptionsRequest.Builder> putConfigurationSetDeliveryOptionsRequest)Associate a configuration set with a dedicated IP pool.default PutConfigurationSetDeliveryOptionsResponseputConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest)Associate a configuration set with a dedicated IP pool.default PutConfigurationSetReputationOptionsResponseputConfigurationSetReputationOptions(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 PutConfigurationSetReputationOptionsResponseputConfigurationSetReputationOptions(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 PutConfigurationSetSendingOptionsResponseputConfigurationSetSendingOptions(Consumer<PutConfigurationSetSendingOptionsRequest.Builder> putConfigurationSetSendingOptionsRequest)Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.default PutConfigurationSetSendingOptionsResponseputConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest)Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.default PutConfigurationSetTrackingOptionsResponseputConfigurationSetTrackingOptions(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 PutConfigurationSetTrackingOptionsResponseputConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest)Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.default PutDedicatedIpInPoolResponseputDedicatedIpInPool(Consumer<PutDedicatedIpInPoolRequest.Builder> putDedicatedIpInPoolRequest)Move a dedicated IP address to an existing dedicated IP pool.default PutDedicatedIpInPoolResponseputDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest)Move a dedicated IP address to an existing dedicated IP pool.default PutDedicatedIpWarmupAttributesResponseputDedicatedIpWarmupAttributes(Consumer<PutDedicatedIpWarmupAttributesRequest.Builder> putDedicatedIpWarmupAttributesRequest)default PutDedicatedIpWarmupAttributesResponseputDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest)default PutDeliverabilityDashboardOptionResponseputDeliverabilityDashboardOption(Consumer<PutDeliverabilityDashboardOptionRequest.Builder> putDeliverabilityDashboardOptionRequest)Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.default PutDeliverabilityDashboardOptionResponseputDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest)Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.default PutEmailIdentityDkimAttributesResponseputEmailIdentityDkimAttributes(Consumer<PutEmailIdentityDkimAttributesRequest.Builder> putEmailIdentityDkimAttributesRequest)Used to enable or disable DKIM authentication for an email identity.default PutEmailIdentityDkimAttributesResponseputEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest)Used to enable or disable DKIM authentication for an email identity.default PutEmailIdentityFeedbackAttributesResponseputEmailIdentityFeedbackAttributes(Consumer<PutEmailIdentityFeedbackAttributesRequest.Builder> putEmailIdentityFeedbackAttributesRequest)Used to enable or disable feedback forwarding for an identity.default PutEmailIdentityFeedbackAttributesResponseputEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest)Used to enable or disable feedback forwarding for an identity.default PutEmailIdentityMailFromAttributesResponseputEmailIdentityMailFromAttributes(Consumer<PutEmailIdentityMailFromAttributesRequest.Builder> putEmailIdentityMailFromAttributesRequest)Used to enable or disable the custom Mail-From domain configuration for an email identity.default PutEmailIdentityMailFromAttributesResponseputEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest)Used to enable or disable the custom Mail-From domain configuration for an email identity.default SendEmailResponsesendEmail(Consumer<SendEmailRequest.Builder> sendEmailRequest)Sends an email message.default SendEmailResponsesendEmail(SendEmailRequest sendEmailRequest)Sends an email message.default PinpointEmailServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Add one or more tags (keys and values) to a specified resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Add one or more tags (keys and values) to a specified resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Remove one or more tags (keys and values) from a specified resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Remove one or more tags (keys and values) from a specified resource.default UpdateConfigurationSetEventDestinationResponseupdateConfigurationSetEventDestination(Consumer<UpdateConfigurationSetEventDestinationRequest.Builder> updateConfigurationSetEventDestinationRequest)Update the configuration of an event destination for a configuration set.default UpdateConfigurationSetEventDestinationResponseupdateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)Update the configuration of an event destination for a configuration set.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createConfigurationSet
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.
- Parameters:
createConfigurationSetRequest- A request to create a configuration set.- Returns:
- Result of the CreateConfigurationSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createConfigurationSet
default 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.Builderavoiding the need to create one manually viaCreateConfigurationSetRequest.builder()- Parameters:
createConfigurationSetRequest- AConsumerthat will call methods onCreateConfigurationSetRequest.Builderto create a request. A request to create a configuration set.- Returns:
- Result of the CreateConfigurationSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createConfigurationSetEventDestination
default 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.
- Parameters:
createConfigurationSetEventDestinationRequest- A request to add an event destination to a configuration set.- Returns:
- Result of the CreateConfigurationSetEventDestination operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createConfigurationSetEventDestination
default 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.Builderavoiding the need to create one manually viaCreateConfigurationSetEventDestinationRequest.builder()- Parameters:
createConfigurationSetEventDestinationRequest- AConsumerthat will call methods onCreateConfigurationSetEventDestinationRequest.Builderto create a request. A request to add an event destination to a configuration set.- Returns:
- Result of the CreateConfigurationSetEventDestination operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDedicatedIpPool
default 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.
- Parameters:
createDedicatedIpPoolRequest- A request to create a new dedicated IP pool.- Returns:
- Result of the CreateDedicatedIpPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDedicatedIpPool
default 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.Builderavoiding the need to create one manually viaCreateDedicatedIpPoolRequest.builder()- Parameters:
createDedicatedIpPoolRequest- AConsumerthat will call methods onCreateDedicatedIpPoolRequest.Builderto create a request. A request to create a new dedicated IP pool.- Returns:
- Result of the CreateDedicatedIpPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDeliverabilityTestReport
default 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
GetDeliverabilityTestReportoperation to view the results of the test.- Parameters:
createDeliverabilityTestReportRequest- A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use theGetDeliverabilityTestReportoperation to view the results of the test.- Returns:
- Result of the CreateDeliverabilityTestReport operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDeliverabilityTestReport
default 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
GetDeliverabilityTestReportoperation to view the results of the test.
This is a convenience which creates an instance of the
CreateDeliverabilityTestReportRequest.Builderavoiding the need to create one manually viaCreateDeliverabilityTestReportRequest.builder()- Parameters:
createDeliverabilityTestReportRequest- AConsumerthat will call methods onCreateDeliverabilityTestReportRequest.Builderto 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 theGetDeliverabilityTestReportoperation to view the results of the test.- Returns:
- Result of the CreateDeliverabilityTestReport operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createEmailIdentity
default 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.
- Parameters:
createEmailIdentityRequest- A request to begin the verification process for an email identity (an email address or domain).- Returns:
- Result of the CreateEmailIdentity operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createEmailIdentity
default 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.Builderavoiding the need to create one manually viaCreateEmailIdentityRequest.builder()- Parameters:
createEmailIdentityRequest- AConsumerthat will call methods onCreateEmailIdentityRequest.Builderto create a request. A request to begin the verification process for an email identity (an email address or domain).- Returns:
- Result of the CreateEmailIdentity operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConfigurationSet
default 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.
- Parameters:
deleteConfigurationSetRequest- A request to delete a configuration set.- Returns:
- Result of the DeleteConfigurationSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConfigurationSet
default 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.Builderavoiding the need to create one manually viaDeleteConfigurationSetRequest.builder()- Parameters:
deleteConfigurationSetRequest- AConsumerthat will call methods onDeleteConfigurationSetRequest.Builderto create a request. A request to delete a configuration set.- Returns:
- Result of the DeleteConfigurationSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConfigurationSetEventDestination
default 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.
- Parameters:
deleteConfigurationSetEventDestinationRequest- A request to delete an event destination from a configuration set.- Returns:
- Result of the DeleteConfigurationSetEventDestination operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteConfigurationSetEventDestination
default 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.Builderavoiding the need to create one manually viaDeleteConfigurationSetEventDestinationRequest.builder()- Parameters:
deleteConfigurationSetEventDestinationRequest- AConsumerthat will call methods onDeleteConfigurationSetEventDestinationRequest.Builderto create a request. A request to delete an event destination from a configuration set.- Returns:
- Result of the DeleteConfigurationSetEventDestination operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDedicatedIpPool
default DeleteDedicatedIpPoolResponse deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException
Delete a dedicated IP pool.
- Parameters:
deleteDedicatedIpPoolRequest- A request to delete a dedicated IP pool.- Returns:
- Result of the DeleteDedicatedIpPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDedicatedIpPool
default 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.Builderavoiding the need to create one manually viaDeleteDedicatedIpPoolRequest.builder()- Parameters:
deleteDedicatedIpPoolRequest- AConsumerthat will call methods onDeleteDedicatedIpPoolRequest.Builderto create a request. A request to delete a dedicated IP pool.- Returns:
- Result of the DeleteDedicatedIpPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEmailIdentity
default 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.
- Parameters:
deleteEmailIdentityRequest- A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.- Returns:
- Result of the DeleteEmailIdentity operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEmailIdentity
default 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.Builderavoiding the need to create one manually viaDeleteEmailIdentityRequest.builder()- Parameters:
deleteEmailIdentityRequest- AConsumerthat will call methods onDeleteEmailIdentityRequest.Builderto create a request. A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.- Returns:
- Result of the DeleteEmailIdentity operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAccount
default 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.
- Parameters:
getAccountRequest- A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.- Returns:
- Result of the GetAccount operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAccount
default 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.Builderavoiding the need to create one manually viaGetAccountRequest.builder()- Parameters:
getAccountRequest- AConsumerthat will call methods onGetAccountRequest.Builderto create a request. A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.- Returns:
- Result of the GetAccount operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAccount
default 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.
- Returns:
- Result of the GetAccount operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getAccount(GetAccountRequest), AWS API Documentation
-
getBlacklistReports
default GetBlacklistReportsResponse getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
- Parameters:
getBlacklistReportsRequest- A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.- Returns:
- Result of the GetBlacklistReports operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getBlacklistReports
default 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.Builderavoiding the need to create one manually viaGetBlacklistReportsRequest.builder()- Parameters:
getBlacklistReportsRequest- AConsumerthat will call methods onGetBlacklistReportsRequest.Builderto create a request. A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.- Returns:
- Result of the GetBlacklistReports operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConfigurationSet
default 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.
- Parameters:
getConfigurationSetRequest- A request to obtain information about a configuration set.- Returns:
- Result of the GetConfigurationSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConfigurationSet
default 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.Builderavoiding the need to create one manually viaGetConfigurationSetRequest.builder()- Parameters:
getConfigurationSetRequest- AConsumerthat will call methods onGetConfigurationSetRequest.Builderto create a request. A request to obtain information about a configuration set.- Returns:
- Result of the GetConfigurationSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConfigurationSetEventDestinations
default 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.
- Parameters:
getConfigurationSetEventDestinationsRequest- A request to obtain information about the event destinations for a configuration set.- Returns:
- Result of the GetConfigurationSetEventDestinations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConfigurationSetEventDestinations
default 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.Builderavoiding the need to create one manually viaGetConfigurationSetEventDestinationsRequest.builder()- Parameters:
getConfigurationSetEventDestinationsRequest- AConsumerthat will call methods onGetConfigurationSetEventDestinationsRequest.Builderto create a request. A request to obtain information about the event destinations for a configuration set.- Returns:
- Result of the GetConfigurationSetEventDestinations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDedicatedIp
default 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.
- Parameters:
getDedicatedIpRequest- A request to obtain more information about a dedicated IP address.- Returns:
- Result of the GetDedicatedIp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDedicatedIp
default 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.Builderavoiding the need to create one manually viaGetDedicatedIpRequest.builder()- Parameters:
getDedicatedIpRequest- AConsumerthat will call methods onGetDedicatedIpRequest.Builderto create a request. A request to obtain more information about a dedicated IP address.- Returns:
- Result of the GetDedicatedIp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDedicatedIps
default GetDedicatedIpsResponse getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
- Parameters:
getDedicatedIpsRequest- A request to obtain more information about dedicated IP pools.- Returns:
- Result of the GetDedicatedIps operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDedicatedIps
default 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.Builderavoiding the need to create one manually viaGetDedicatedIpsRequest.builder()- Parameters:
getDedicatedIpsRequest- AConsumerthat will call methods onGetDedicatedIpsRequest.Builderto create a request. A request to obtain more information about dedicated IP pools.- Returns:
- Result of the GetDedicatedIps operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDedicatedIpsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
getDedicatedIpsRequest- A request to obtain more information about dedicated IP pools.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDedicatedIpsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetDedicatedIpsRequest.builder()- Parameters:
getDedicatedIpsRequest- AConsumerthat will call methods onGetDedicatedIpsRequest.Builderto create a request. A request to obtain more information about dedicated IP pools.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeliverabilityDashboardOptions
default 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.
- Parameters:
getDeliverabilityDashboardOptionsRequest- Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- Result of the GetDeliverabilityDashboardOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeliverabilityDashboardOptions
default 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.Builderavoiding the need to create one manually viaGetDeliverabilityDashboardOptionsRequest.builder()- Parameters:
getDeliverabilityDashboardOptionsRequest- AConsumerthat will call methods onGetDeliverabilityDashboardOptionsRequest.Builderto create a request. Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- Result of the GetDeliverabilityDashboardOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeliverabilityDashboardOptions
default 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.
- Returns:
- Result of the GetDeliverabilityDashboardOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest), AWS API Documentation
-
getDeliverabilityTestReport
default GetDeliverabilityTestReportResponse getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest) throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
Retrieve the results of a predictive inbox placement test.
- Parameters:
getDeliverabilityTestReportRequest- A request to retrieve the results of a predictive inbox placement test.- Returns:
- Result of the GetDeliverabilityTestReport operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeliverabilityTestReport
default 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.Builderavoiding the need to create one manually viaGetDeliverabilityTestReportRequest.builder()- Parameters:
getDeliverabilityTestReportRequest- AConsumerthat will call methods onGetDeliverabilityTestReportRequest.Builderto create a request. A request to retrieve the results of a predictive inbox placement test.- Returns:
- Result of the GetDeliverabilityTestReport operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDomainDeliverabilityCampaign
default 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 (
PutDeliverabilityDashboardOptionoperation).- Parameters:
getDomainDeliverabilityCampaignRequest- Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOptionoperation).- Returns:
- Result of the GetDomainDeliverabilityCampaign operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDomainDeliverabilityCampaign
default 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 (
PutDeliverabilityDashboardOptionoperation).
This is a convenience which creates an instance of the
GetDomainDeliverabilityCampaignRequest.Builderavoiding the need to create one manually viaGetDomainDeliverabilityCampaignRequest.builder()- Parameters:
getDomainDeliverabilityCampaignRequest- AConsumerthat will call methods onGetDomainDeliverabilityCampaignRequest.Builderto 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 (PutDeliverabilityDashboardOptionoperation).- Returns:
- Result of the GetDomainDeliverabilityCampaign operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDomainStatisticsReport
default 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.
- Parameters:
getDomainStatisticsReportRequest- A request to obtain deliverability metrics for a domain.- Returns:
- Result of the GetDomainStatisticsReport operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDomainStatisticsReport
default 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.Builderavoiding the need to create one manually viaGetDomainStatisticsReportRequest.builder()- Parameters:
getDomainStatisticsReportRequest- AConsumerthat will call methods onGetDomainStatisticsReportRequest.Builderto create a request. A request to obtain deliverability metrics for a domain.- Returns:
- Result of the GetDomainStatisticsReport operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEmailIdentity
default 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.
- Parameters:
getEmailIdentityRequest- A request to return details about an email identity.- Returns:
- Result of the GetEmailIdentity operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEmailIdentity
default 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.Builderavoiding the need to create one manually viaGetEmailIdentityRequest.builder()- Parameters:
getEmailIdentityRequest- AConsumerthat will call methods onGetEmailIdentityRequest.Builderto create a request. A request to return details about an email identity.- Returns:
- Result of the GetEmailIdentity operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConfigurationSets
default 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.
- Parameters:
listConfigurationSetsRequest- A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.- Returns:
- Result of the ListConfigurationSets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConfigurationSets
default 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.Builderavoiding the need to create one manually viaListConfigurationSetsRequest.builder()- Parameters:
listConfigurationSetsRequest- AConsumerthat will call methods onListConfigurationSetsRequest.Builderto create a request. A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.- Returns:
- Result of the ListConfigurationSets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConfigurationSetsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listConfigurationSetsRequest- A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listConfigurationSetsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListConfigurationSetsRequest.builder()- Parameters:
listConfigurationSetsRequest- AConsumerthat will call methods onListConfigurationSetsRequest.Builderto create a request. A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDedicatedIpPools
default 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.
- Parameters:
listDedicatedIpPoolsRequest- A request to obtain a list of dedicated IP pools.- Returns:
- Result of the ListDedicatedIpPools operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDedicatedIpPools
default 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.Builderavoiding the need to create one manually viaListDedicatedIpPoolsRequest.builder()- Parameters:
listDedicatedIpPoolsRequest- AConsumerthat will call methods onListDedicatedIpPoolsRequest.Builderto create a request. A request to obtain a list of dedicated IP pools.- Returns:
- Result of the ListDedicatedIpPools operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDedicatedIpPoolsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listDedicatedIpPoolsRequest- A request to obtain a list of dedicated IP pools.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDedicatedIpPoolsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListDedicatedIpPoolsRequest.builder()- Parameters:
listDedicatedIpPoolsRequest- AConsumerthat will call methods onListDedicatedIpPoolsRequest.Builderto create a request. A request to obtain a list of dedicated IP pools.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeliverabilityTestReports
default 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
GetDeliverabilityTestReportoperation to view the results.- Parameters:
listDeliverabilityTestReportsRequest- A request to list all of the predictive inbox placement tests that you've performed.- Returns:
- Result of the ListDeliverabilityTestReports operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeliverabilityTestReports
default 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
GetDeliverabilityTestReportoperation to view the results.
This is a convenience which creates an instance of the
ListDeliverabilityTestReportsRequest.Builderavoiding the need to create one manually viaListDeliverabilityTestReportsRequest.builder()- Parameters:
listDeliverabilityTestReportsRequest- AConsumerthat will call methods onListDeliverabilityTestReportsRequest.Builderto create a request. A request to list all of the predictive inbox placement tests that you've performed.- Returns:
- Result of the ListDeliverabilityTestReports operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeliverabilityTestReportsPaginator
default 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
GetDeliverabilityTestReportoperation 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listDeliverabilityTestReportsRequest- A request to list all of the predictive inbox placement tests that you've performed.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeliverabilityTestReportsPaginator
default 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
GetDeliverabilityTestReportoperation 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListDeliverabilityTestReportsRequest.builder()- Parameters:
listDeliverabilityTestReportsRequest- AConsumerthat will call methods onListDeliverabilityTestReportsRequest.Builderto create a request. A request to list all of the predictive inbox placement tests that you've performed.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainDeliverabilityCampaigns
default 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 (
PutDeliverabilityDashboardOptionoperation) for the domain.- Parameters:
listDomainDeliverabilityCampaignsRequest- Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOptionoperation) for the domain.- Returns:
- Result of the ListDomainDeliverabilityCampaigns operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainDeliverabilityCampaigns
default 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 (
PutDeliverabilityDashboardOptionoperation) for the domain.
This is a convenience which creates an instance of the
ListDomainDeliverabilityCampaignsRequest.Builderavoiding the need to create one manually viaListDomainDeliverabilityCampaignsRequest.builder()- Parameters:
listDomainDeliverabilityCampaignsRequest- AConsumerthat will call methods onListDomainDeliverabilityCampaignsRequest.Builderto 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 (PutDeliverabilityDashboardOptionoperation) for the domain.- Returns:
- Result of the ListDomainDeliverabilityCampaigns operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainDeliverabilityCampaignsPaginator
default 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 (
PutDeliverabilityDashboardOptionoperation) 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listDomainDeliverabilityCampaignsRequest- Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOptionoperation) for the domain.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainDeliverabilityCampaignsPaginator
default 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 (
PutDeliverabilityDashboardOptionoperation) 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListDomainDeliverabilityCampaignsRequest.builder()- Parameters:
listDomainDeliverabilityCampaignsRequest- AConsumerthat will call methods onListDomainDeliverabilityCampaignsRequest.Builderto 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 (PutDeliverabilityDashboardOptionoperation) for the domain.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEmailIdentities
default 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.
- Parameters:
listEmailIdentitiesRequest- A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.- Returns:
- Result of the ListEmailIdentities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEmailIdentities
default 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.Builderavoiding the need to create one manually viaListEmailIdentitiesRequest.builder()- Parameters:
listEmailIdentitiesRequest- AConsumerthat will call methods onListEmailIdentitiesRequest.Builderto create a request. A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.- Returns:
- Result of the ListEmailIdentities operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEmailIdentitiesPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listEmailIdentitiesRequest- A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEmailIdentitiesPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListEmailIdentitiesRequest.builder()- Parameters:
listEmailIdentitiesRequest- AConsumerthat will call methods onListEmailIdentitiesRequest.Builderto create a request. A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default 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.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAccountDedicatedIpWarmupAttributes
default PutAccountDedicatedIpWarmupAttributesResponse putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
Enable or disable the automatic warm-up feature for dedicated IP addresses.
- Parameters:
putAccountDedicatedIpWarmupAttributesRequest- A request to enable or disable the automatic IP address warm-up feature.- Returns:
- Result of the PutAccountDedicatedIpWarmupAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAccountDedicatedIpWarmupAttributes
default 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.Builderavoiding the need to create one manually viaPutAccountDedicatedIpWarmupAttributesRequest.builder()- Parameters:
putAccountDedicatedIpWarmupAttributesRequest- AConsumerthat will call methods onPutAccountDedicatedIpWarmupAttributesRequest.Builderto create a request. A request to enable or disable the automatic IP address warm-up feature.- Returns:
- Result of the PutAccountDedicatedIpWarmupAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAccountSendingAttributes
default PutAccountSendingAttributesResponse putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest) throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
Enable or disable the ability of your account to send email.
- Parameters:
putAccountSendingAttributesRequest- A request to change the ability of your account to send email.- Returns:
- Result of the PutAccountSendingAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAccountSendingAttributes
default 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.Builderavoiding the need to create one manually viaPutAccountSendingAttributesRequest.builder()- Parameters:
putAccountSendingAttributesRequest- AConsumerthat will call methods onPutAccountSendingAttributesRequest.Builderto create a request. A request to change the ability of your account to send email.- Returns:
- Result of the PutAccountSendingAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putConfigurationSetDeliveryOptions
default 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.
- Parameters:
putConfigurationSetDeliveryOptionsRequest- A request to associate a configuration set with a dedicated IP pool.- Returns:
- Result of the PutConfigurationSetDeliveryOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putConfigurationSetDeliveryOptions
default 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.Builderavoiding the need to create one manually viaPutConfigurationSetDeliveryOptionsRequest.builder()- Parameters:
putConfigurationSetDeliveryOptionsRequest- AConsumerthat will call methods onPutConfigurationSetDeliveryOptionsRequest.Builderto create a request. A request to associate a configuration set with a dedicated IP pool.- Returns:
- Result of the PutConfigurationSetDeliveryOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putConfigurationSetReputationOptions
default 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.
- Parameters:
putConfigurationSetReputationOptionsRequest- A request to enable or disable tracking of reputation metrics for a configuration set.- Returns:
- Result of the PutConfigurationSetReputationOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putConfigurationSetReputationOptions
default 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.Builderavoiding the need to create one manually viaPutConfigurationSetReputationOptionsRequest.builder()- Parameters:
putConfigurationSetReputationOptionsRequest- AConsumerthat will call methods onPutConfigurationSetReputationOptionsRequest.Builderto create a request. A request to enable or disable tracking of reputation metrics for a configuration set.- Returns:
- Result of the PutConfigurationSetReputationOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putConfigurationSetSendingOptions
default 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.
- Parameters:
putConfigurationSetSendingOptionsRequest- A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.- Returns:
- Result of the PutConfigurationSetSendingOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putConfigurationSetSendingOptions
default 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.Builderavoiding the need to create one manually viaPutConfigurationSetSendingOptionsRequest.builder()- Parameters:
putConfigurationSetSendingOptionsRequest- AConsumerthat will call methods onPutConfigurationSetSendingOptionsRequest.Builderto create a request. A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.- Returns:
- Result of the PutConfigurationSetSendingOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putConfigurationSetTrackingOptions
default 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.
- Parameters:
putConfigurationSetTrackingOptionsRequest- A request to add a custom domain for tracking open and click events to a configuration set.- Returns:
- Result of the PutConfigurationSetTrackingOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putConfigurationSetTrackingOptions
default 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.Builderavoiding the need to create one manually viaPutConfigurationSetTrackingOptionsRequest.builder()- Parameters:
putConfigurationSetTrackingOptionsRequest- AConsumerthat will call methods onPutConfigurationSetTrackingOptionsRequest.Builderto create a request. A request to add a custom domain for tracking open and click events to a configuration set.- Returns:
- Result of the PutConfigurationSetTrackingOptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putDedicatedIpInPool
default 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
CreateDedicatedIpPooloperation.- Parameters:
putDedicatedIpInPoolRequest- A request to move a dedicated IP address to a dedicated IP pool.- Returns:
- Result of the PutDedicatedIpInPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putDedicatedIpInPool
default 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
CreateDedicatedIpPooloperation.
This is a convenience which creates an instance of the
PutDedicatedIpInPoolRequest.Builderavoiding the need to create one manually viaPutDedicatedIpInPoolRequest.builder()- Parameters:
putDedicatedIpInPoolRequest- AConsumerthat will call methods onPutDedicatedIpInPoolRequest.Builderto create a request. A request to move a dedicated IP address to a dedicated IP pool.- Returns:
- Result of the PutDedicatedIpInPool operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putDedicatedIpWarmupAttributes
default PutDedicatedIpWarmupAttributesResponse putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
- Parameters:
putDedicatedIpWarmupAttributesRequest- A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.- Returns:
- Result of the PutDedicatedIpWarmupAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putDedicatedIpWarmupAttributes
default PutDedicatedIpWarmupAttributesResponse putDedicatedIpWarmupAttributes(Consumer<PutDedicatedIpWarmupAttributesRequest.Builder> putDedicatedIpWarmupAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
This is a convenience which creates an instance of the
PutDedicatedIpWarmupAttributesRequest.Builderavoiding the need to create one manually viaPutDedicatedIpWarmupAttributesRequest.builder()- Parameters:
putDedicatedIpWarmupAttributesRequest- AConsumerthat will call methods onPutDedicatedIpWarmupAttributesRequest.Builderto create a request. A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.- Returns:
- Result of the PutDedicatedIpWarmupAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putDeliverabilityDashboardOption
default 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.
- Parameters:
putDeliverabilityDashboardOptionRequest- Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- Result of the PutDeliverabilityDashboardOption operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putDeliverabilityDashboardOption
default 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.Builderavoiding the need to create one manually viaPutDeliverabilityDashboardOptionRequest.builder()- Parameters:
putDeliverabilityDashboardOptionRequest- AConsumerthat will call methods onPutDeliverabilityDashboardOptionRequest.Builderto create a request. Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
- Returns:
- Result of the PutDeliverabilityDashboardOption operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putEmailIdentityDkimAttributes
default PutEmailIdentityDkimAttributesResponse putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest) throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException
Used to enable or disable DKIM authentication for an email identity.
- Parameters:
putEmailIdentityDkimAttributesRequest- A request to enable or disable DKIM signing of email that you send from an email identity.- Returns:
- Result of the PutEmailIdentityDkimAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putEmailIdentityDkimAttributes
default 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.Builderavoiding the need to create one manually viaPutEmailIdentityDkimAttributesRequest.builder()- Parameters:
putEmailIdentityDkimAttributesRequest- AConsumerthat will call methods onPutEmailIdentityDkimAttributesRequest.Builderto create a request. A request to enable or disable DKIM signing of email that you send from an email identity.- Returns:
- Result of the PutEmailIdentityDkimAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putEmailIdentityFeedbackAttributes
default 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).
- Parameters:
putEmailIdentityFeedbackAttributesRequest- A request to set the attributes that control how bounce and complaint events are processed.- Returns:
- Result of the PutEmailIdentityFeedbackAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putEmailIdentityFeedbackAttributes
default 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.Builderavoiding the need to create one manually viaPutEmailIdentityFeedbackAttributesRequest.builder()- Parameters:
putEmailIdentityFeedbackAttributesRequest- AConsumerthat will call methods onPutEmailIdentityFeedbackAttributesRequest.Builderto create a request. A request to set the attributes that control how bounce and complaint events are processed.- Returns:
- Result of the PutEmailIdentityFeedbackAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putEmailIdentityMailFromAttributes
default 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.
- Parameters:
putEmailIdentityMailFromAttributesRequest- A request to configure the custom MAIL FROM domain for a verified identity.- Returns:
- Result of the PutEmailIdentityMailFromAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putEmailIdentityMailFromAttributes
default 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.Builderavoiding the need to create one manually viaPutEmailIdentityMailFromAttributesRequest.builder()- Parameters:
putEmailIdentityMailFromAttributesRequest- AConsumerthat will call methods onPutEmailIdentityMailFromAttributesRequest.Builderto create a request. A request to configure the custom MAIL FROM domain for a verified identity.- Returns:
- Result of the PutEmailIdentityMailFromAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
sendEmail
default 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.
- Parameters:
sendEmailRequest- A request to send an email message.- Returns:
- Result of the SendEmail operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
sendEmail
default 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.Builderavoiding the need to create one manually viaSendEmailRequest.builder()- Parameters:
sendEmailRequest- AConsumerthat will call methods onSendEmailRequest.Builderto create a request. A request to send an email message.- Returns:
- Result of the SendEmail operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
tagResource
default 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.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, ConcurrentModificationException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointEmailException
Remove one or more tags (keys and values) from a specified resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateConfigurationSetEventDestination
default 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.
- Parameters:
updateConfigurationSetEventDestinationRequest- A request to change the settings for an event destination for a configuration set.- Returns:
- Result of the UpdateConfigurationSetEventDestination operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateConfigurationSetEventDestination
default 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.Builderavoiding the need to create one manually viaUpdateConfigurationSetEventDestinationRequest.builder()- Parameters:
updateConfigurationSetEventDestinationRequest- AConsumerthat will call methods onUpdateConfigurationSetEventDestinationRequest.Builderto create a request. A request to change the settings for an event destination for a configuration set.- Returns:
- Result of the UpdateConfigurationSetEventDestination operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static PinpointEmailClient create()
Create aPinpointEmailClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PinpointEmailClientBuilder builder()
Create a builder that can be used to configure and create aPinpointEmailClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default PinpointEmailServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-