software.amazon.awssdk.services.pinpointemail.PinpointEmailClient Maven / Gradle / Ivy
Show all versions of pinpointemail Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.pinpointemail;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.pinpointemail.model.AccountSuspendedException;
import software.amazon.awssdk.services.pinpointemail.model.AlreadyExistsException;
import software.amazon.awssdk.services.pinpointemail.model.BadRequestException;
import software.amazon.awssdk.services.pinpointemail.model.ConcurrentModificationException;
import software.amazon.awssdk.services.pinpointemail.model.CreateConfigurationSetEventDestinationRequest;
import software.amazon.awssdk.services.pinpointemail.model.CreateConfigurationSetEventDestinationResponse;
import software.amazon.awssdk.services.pinpointemail.model.CreateConfigurationSetRequest;
import software.amazon.awssdk.services.pinpointemail.model.CreateConfigurationSetResponse;
import software.amazon.awssdk.services.pinpointemail.model.CreateDedicatedIpPoolRequest;
import software.amazon.awssdk.services.pinpointemail.model.CreateDedicatedIpPoolResponse;
import software.amazon.awssdk.services.pinpointemail.model.CreateDeliverabilityTestReportRequest;
import software.amazon.awssdk.services.pinpointemail.model.CreateDeliverabilityTestReportResponse;
import software.amazon.awssdk.services.pinpointemail.model.CreateEmailIdentityRequest;
import software.amazon.awssdk.services.pinpointemail.model.CreateEmailIdentityResponse;
import software.amazon.awssdk.services.pinpointemail.model.DeleteConfigurationSetEventDestinationRequest;
import software.amazon.awssdk.services.pinpointemail.model.DeleteConfigurationSetEventDestinationResponse;
import software.amazon.awssdk.services.pinpointemail.model.DeleteConfigurationSetRequest;
import software.amazon.awssdk.services.pinpointemail.model.DeleteConfigurationSetResponse;
import software.amazon.awssdk.services.pinpointemail.model.DeleteDedicatedIpPoolRequest;
import software.amazon.awssdk.services.pinpointemail.model.DeleteDedicatedIpPoolResponse;
import software.amazon.awssdk.services.pinpointemail.model.DeleteEmailIdentityRequest;
import software.amazon.awssdk.services.pinpointemail.model.DeleteEmailIdentityResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetAccountRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetAccountResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetBlacklistReportsRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetBlacklistReportsResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetConfigurationSetEventDestinationsRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetConfigurationSetEventDestinationsResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetConfigurationSetRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetConfigurationSetResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetDeliverabilityDashboardOptionsRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetDeliverabilityDashboardOptionsResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetDeliverabilityTestReportRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetDeliverabilityTestReportResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetDomainDeliverabilityCampaignRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetDomainDeliverabilityCampaignResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetDomainStatisticsReportRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetDomainStatisticsReportResponse;
import software.amazon.awssdk.services.pinpointemail.model.GetEmailIdentityRequest;
import software.amazon.awssdk.services.pinpointemail.model.GetEmailIdentityResponse;
import software.amazon.awssdk.services.pinpointemail.model.LimitExceededException;
import software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest;
import software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse;
import software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest;
import software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse;
import software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest;
import software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse;
import software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest;
import software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse;
import software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest;
import software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse;
import software.amazon.awssdk.services.pinpointemail.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.pinpointemail.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.pinpointemail.model.MailFromDomainNotVerifiedException;
import software.amazon.awssdk.services.pinpointemail.model.MessageRejectedException;
import software.amazon.awssdk.services.pinpointemail.model.NotFoundException;
import software.amazon.awssdk.services.pinpointemail.model.PinpointEmailException;
import software.amazon.awssdk.services.pinpointemail.model.PutAccountDedicatedIpWarmupAttributesRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutAccountDedicatedIpWarmupAttributesResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutAccountSendingAttributesRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutAccountSendingAttributesResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetDeliveryOptionsRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetDeliveryOptionsResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetReputationOptionsRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetReputationOptionsResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetSendingOptionsRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetSendingOptionsResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetTrackingOptionsRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetTrackingOptionsResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutDedicatedIpInPoolRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutDedicatedIpInPoolResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutDedicatedIpWarmupAttributesRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutDedicatedIpWarmupAttributesResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutDeliverabilityDashboardOptionRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutDeliverabilityDashboardOptionResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityDkimAttributesRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityDkimAttributesResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityFeedbackAttributesRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityFeedbackAttributesResponse;
import software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityMailFromAttributesRequest;
import software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityMailFromAttributesResponse;
import software.amazon.awssdk.services.pinpointemail.model.SendEmailRequest;
import software.amazon.awssdk.services.pinpointemail.model.SendEmailResponse;
import software.amazon.awssdk.services.pinpointemail.model.SendingPausedException;
import software.amazon.awssdk.services.pinpointemail.model.TagResourceRequest;
import software.amazon.awssdk.services.pinpointemail.model.TagResourceResponse;
import software.amazon.awssdk.services.pinpointemail.model.TooManyRequestsException;
import software.amazon.awssdk.services.pinpointemail.model.UntagResourceRequest;
import software.amazon.awssdk.services.pinpointemail.model.UntagResourceResponse;
import software.amazon.awssdk.services.pinpointemail.model.UpdateConfigurationSetEventDestinationRequest;
import software.amazon.awssdk.services.pinpointemail.model.UpdateConfigurationSetEventDestinationResponse;
import software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable;
import software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable;
import software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable;
import software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable;
import software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable;
import software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable;
/**
* Service client for accessing Pinpoint Email. This can be created using the static {@link #builder()} 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface PinpointEmailClient extends AwsClient {
String SERVICE_NAME = "ses";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "email";
/**
*
* 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.
*
*
* @param createConfigurationSetRequest
* A request to create a configuration set.
* @return Result of the CreateConfigurationSet operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateConfigurationSet
* @see AWS API Documentation
*/
default CreateConfigurationSetResponse createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
throws AlreadyExistsException, NotFoundException, TooManyRequestsException, LimitExceededException,
BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateConfigurationSetRequest.Builder} avoiding the
* need to create one manually via {@link CreateConfigurationSetRequest#builder()}
*
*
* @param createConfigurationSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.CreateConfigurationSetRequest.Builder} to
* create a request. A request to create a configuration set.
* @return Result of the CreateConfigurationSet operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateConfigurationSet
* @see AWS API Documentation
*/
default CreateConfigurationSetResponse createConfigurationSet(
Consumer createConfigurationSetRequest) throws AlreadyExistsException,
NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException,
ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException {
return createConfigurationSet(CreateConfigurationSetRequest.builder().applyMutation(createConfigurationSetRequest)
.build());
}
/**
*
* 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.
*
*
* @param createConfigurationSetEventDestinationRequest
* A request to add an event destination to a configuration set.
* @return Result of the CreateConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateConfigurationSetEventDestination
* @see AWS API Documentation
*/
default CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(
CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
throws NotFoundException, AlreadyExistsException, LimitExceededException, TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link CreateConfigurationSetEventDestinationRequest.Builder} avoiding the need to create one manually via
* {@link CreateConfigurationSetEventDestinationRequest#builder()}
*
*
* @param createConfigurationSetEventDestinationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.CreateConfigurationSetEventDestinationRequest.Builder}
* to create a request. A request to add an event destination to a configuration set.
* @return Result of the CreateConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateConfigurationSetEventDestination
* @see AWS API Documentation
*/
default CreateConfigurationSetEventDestinationResponse createConfigurationSetEventDestination(
Consumer createConfigurationSetEventDestinationRequest)
throws NotFoundException, AlreadyExistsException, LimitExceededException, TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest.builder()
.applyMutation(createConfigurationSetEventDestinationRequest).build());
}
/**
*
* 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.
*
*
* @param createDedicatedIpPoolRequest
* A request to create a new dedicated IP pool.
* @return Result of the CreateDedicatedIpPool operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateDedicatedIpPool
* @see AWS API Documentation
*/
default CreateDedicatedIpPoolResponse createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest)
throws AlreadyExistsException, LimitExceededException, TooManyRequestsException, BadRequestException,
ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDedicatedIpPoolRequest.Builder} avoiding the
* need to create one manually via {@link CreateDedicatedIpPoolRequest#builder()}
*
*
* @param createDedicatedIpPoolRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.CreateDedicatedIpPoolRequest.Builder} to create
* a request. A request to create a new dedicated IP pool.
* @return Result of the CreateDedicatedIpPool operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateDedicatedIpPool
* @see AWS API Documentation
*/
default CreateDedicatedIpPoolResponse createDedicatedIpPool(
Consumer createDedicatedIpPoolRequest) throws AlreadyExistsException,
LimitExceededException, TooManyRequestsException, BadRequestException, ConcurrentModificationException,
AwsServiceException, SdkClientException, PinpointEmailException {
return createDedicatedIpPool(CreateDedicatedIpPoolRequest.builder().applyMutation(createDedicatedIpPoolRequest).build());
}
/**
*
* Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your
* messages will be handled by various email providers around the world. When you perform a predictive inbox
* placement test, you provide a sample message that contains the content that you plan to send to your customers.
* Amazon Pinpoint then sends that message to special email addresses spread across several major email providers.
* After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport
* operation to view the results of the test.
*
*
* @param createDeliverabilityTestReportRequest
* A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you
* predict how your messages will be handled by various email providers around the world. When you perform a
* predictive inbox placement test, you provide a sample message that contains the content that you plan to
* send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across
* several major email providers. After about 24 hours, the test is complete, and you can use the
* GetDeliverabilityTestReport operation to view the results of the test.
* @return 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.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateDeliverabilityTestReport
* @see AWS API Documentation
*/
default CreateDeliverabilityTestReportResponse createDeliverabilityTestReport(
CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest) throws AccountSuspendedException,
SendingPausedException, MessageRejectedException, MailFromDomainNotVerifiedException, NotFoundException,
TooManyRequestsException, LimitExceededException, BadRequestException, ConcurrentModificationException,
AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your
* messages will be handled by various email providers around the world. When you perform a predictive inbox
* placement test, you provide a sample message that contains the content that you plan to send to your customers.
* Amazon Pinpoint then sends that message to special email addresses spread across several major email providers.
* After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport
* operation to view the results of the test.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDeliverabilityTestReportRequest.Builder}
* avoiding the need to create one manually via {@link CreateDeliverabilityTestReportRequest#builder()}
*
*
* @param createDeliverabilityTestReportRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.CreateDeliverabilityTestReportRequest.Builder}
* to create a request. A request to perform a predictive inbox placement test. Predictive inbox placement
* tests can help you predict how your messages will be handled by various email providers around the world.
* When you perform a predictive inbox placement test, you provide a sample message that contains the content
* that you plan to send to your customers. Amazon Pinpoint then sends that message to special email
* addresses spread across several major email providers. After about 24 hours, the test is complete, and you
* can use the GetDeliverabilityTestReport operation to view the results of the test.
* @return 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.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateDeliverabilityTestReport
* @see AWS API Documentation
*/
default CreateDeliverabilityTestReportResponse createDeliverabilityTestReport(
Consumer createDeliverabilityTestReportRequest)
throws AccountSuspendedException, SendingPausedException, MessageRejectedException,
MailFromDomainNotVerifiedException, NotFoundException, TooManyRequestsException, LimitExceededException,
BadRequestException, ConcurrentModificationException, AwsServiceException, SdkClientException, PinpointEmailException {
return createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest.builder()
.applyMutation(createDeliverabilityTestReportRequest).build());
}
/**
*
* 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.
*
*
* @param createEmailIdentityRequest
* A request to begin the verification process for an email identity (an email address or domain).
* @return Result of the CreateEmailIdentity operation returned by the service.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateEmailIdentity
* @see AWS API Documentation
*/
default CreateEmailIdentityResponse createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest)
throws LimitExceededException, TooManyRequestsException, BadRequestException, ConcurrentModificationException,
AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateEmailIdentityRequest.Builder} avoiding the
* need to create one manually via {@link CreateEmailIdentityRequest#builder()}
*
*
* @param createEmailIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.CreateEmailIdentityRequest.Builder} to create a
* request. A request to begin the verification process for an email identity (an email address or domain).
* @return Result of the CreateEmailIdentity operation returned by the service.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.CreateEmailIdentity
* @see AWS API Documentation
*/
default CreateEmailIdentityResponse createEmailIdentity(
Consumer createEmailIdentityRequest) throws LimitExceededException,
TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException,
SdkClientException, PinpointEmailException {
return createEmailIdentity(CreateEmailIdentityRequest.builder().applyMutation(createEmailIdentityRequest).build());
}
/**
*
* 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.
*
*
* @param deleteConfigurationSetRequest
* A request to delete a configuration set.
* @return Result of the DeleteConfigurationSet operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.DeleteConfigurationSet
* @see AWS API Documentation
*/
default DeleteConfigurationSetResponse deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException,
AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteConfigurationSetRequest.Builder} avoiding the
* need to create one manually via {@link DeleteConfigurationSetRequest#builder()}
*
*
* @param deleteConfigurationSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.DeleteConfigurationSetRequest.Builder} to
* create a request. A request to delete a configuration set.
* @return Result of the DeleteConfigurationSet operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.DeleteConfigurationSet
* @see AWS API Documentation
*/
default DeleteConfigurationSetResponse deleteConfigurationSet(
Consumer deleteConfigurationSetRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException,
SdkClientException, PinpointEmailException {
return deleteConfigurationSet(DeleteConfigurationSetRequest.builder().applyMutation(deleteConfigurationSetRequest)
.build());
}
/**
*
* 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.
*
*
* @param deleteConfigurationSetEventDestinationRequest
* A request to delete an event destination from a configuration set.
* @return Result of the DeleteConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.DeleteConfigurationSetEventDestination
* @see AWS API Documentation
*/
default DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(
DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link DeleteConfigurationSetEventDestinationRequest.Builder} avoiding the need to create one manually via
* {@link DeleteConfigurationSetEventDestinationRequest#builder()}
*
*
* @param deleteConfigurationSetEventDestinationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.DeleteConfigurationSetEventDestinationRequest.Builder}
* to create a request. A request to delete an event destination from a configuration set.
* @return Result of the DeleteConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.DeleteConfigurationSetEventDestination
* @see AWS API Documentation
*/
default DeleteConfigurationSetEventDestinationResponse deleteConfigurationSetEventDestination(
Consumer deleteConfigurationSetEventDestinationRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest.builder()
.applyMutation(deleteConfigurationSetEventDestinationRequest).build());
}
/**
*
* Delete a dedicated IP pool.
*
*
* @param deleteDedicatedIpPoolRequest
* A request to delete a dedicated IP pool.
* @return Result of the DeleteDedicatedIpPool operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.DeleteDedicatedIpPool
* @see AWS API Documentation
*/
default DeleteDedicatedIpPoolResponse deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException,
AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Delete a dedicated IP pool.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDedicatedIpPoolRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDedicatedIpPoolRequest#builder()}
*
*
* @param deleteDedicatedIpPoolRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.DeleteDedicatedIpPoolRequest.Builder} to create
* a request. A request to delete a dedicated IP pool.
* @return Result of the DeleteDedicatedIpPool operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.DeleteDedicatedIpPool
* @see AWS API Documentation
*/
default DeleteDedicatedIpPoolResponse deleteDedicatedIpPool(
Consumer deleteDedicatedIpPoolRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException,
SdkClientException, PinpointEmailException {
return deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest.builder().applyMutation(deleteDedicatedIpPoolRequest).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Result of the DeleteEmailIdentity operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.DeleteEmailIdentity
* @see AWS API Documentation
*/
default DeleteEmailIdentityResponse deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, ConcurrentModificationException,
AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteEmailIdentityRequest.Builder} avoiding the
* need to create one manually via {@link DeleteEmailIdentityRequest#builder()}
*
*
* @param deleteEmailIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.DeleteEmailIdentityRequest.Builder} to create a
* request. A request to delete an existing email identity. When you delete an identity, you lose the ability
* to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by
* completing the verification process for the identity again.
* @return Result of the DeleteEmailIdentity operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.DeleteEmailIdentity
* @see AWS API Documentation
*/
default DeleteEmailIdentityResponse deleteEmailIdentity(
Consumer deleteEmailIdentityRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, ConcurrentModificationException, AwsServiceException,
SdkClientException, PinpointEmailException {
return deleteEmailIdentity(DeleteEmailIdentityRequest.builder().applyMutation(deleteEmailIdentityRequest).build());
}
/**
*
* Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current
* AWS Region.
*
*
* @param getAccountRequest
* A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
* @return Result of the GetAccount operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetAccount
* @see AWS API
* Documentation
*/
default GetAccountResponse getAccount(GetAccountRequest getAccountRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetAccountRequest.Builder} avoiding the need to
* create one manually via {@link GetAccountRequest#builder()}
*
*
* @param getAccountRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetAccountRequest.Builder} to create a request.
* A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
* @return Result of the GetAccount operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetAccount
* @see AWS API
* Documentation
*/
default GetAccountResponse getAccount(Consumer getAccountRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return getAccount(GetAccountRequest.builder().applyMutation(getAccountRequest).build());
}
/**
*
* Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current
* AWS Region.
*
*
* @return Result of the GetAccount operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetAccount
* @see #getAccount(GetAccountRequest)
* @see AWS API
* Documentation
*/
default GetAccountResponse getAccount() throws TooManyRequestsException, BadRequestException, AwsServiceException,
SdkClientException, PinpointEmailException {
return getAccount(GetAccountRequest.builder().build());
}
/**
*
* Retrieve a list of the blacklists that your dedicated IP addresses appear on.
*
*
* @param getBlacklistReportsRequest
* A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
* @return Result of the GetBlacklistReports operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetBlacklistReports
* @see AWS API Documentation
*/
default GetBlacklistReportsResponse getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieve a list of the blacklists that your dedicated IP addresses appear on.
*
*
*
* This is a convenience which creates an instance of the {@link GetBlacklistReportsRequest.Builder} avoiding the
* need to create one manually via {@link GetBlacklistReportsRequest#builder()}
*
*
* @param getBlacklistReportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetBlacklistReportsRequest.Builder} to create a
* request. A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
* @return Result of the GetBlacklistReports operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetBlacklistReports
* @see AWS API Documentation
*/
default GetBlacklistReportsResponse getBlacklistReports(
Consumer getBlacklistReportsRequest) throws TooManyRequestsException,
NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return getBlacklistReports(GetBlacklistReportsRequest.builder().applyMutation(getBlacklistReportsRequest).build());
}
/**
*
* 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.
*
*
* @param getConfigurationSetRequest
* A request to obtain information about a configuration set.
* @return Result of the GetConfigurationSet operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetConfigurationSet
* @see AWS API Documentation
*/
default GetConfigurationSetResponse getConfigurationSet(GetConfigurationSetRequest getConfigurationSetRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetConfigurationSetRequest.Builder} avoiding the
* need to create one manually via {@link GetConfigurationSetRequest#builder()}
*
*
* @param getConfigurationSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetConfigurationSetRequest.Builder} to create a
* request. A request to obtain information about a configuration set.
* @return Result of the GetConfigurationSet operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetConfigurationSet
* @see AWS API Documentation
*/
default GetConfigurationSetResponse getConfigurationSet(
Consumer getConfigurationSetRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return getConfigurationSet(GetConfigurationSetRequest.builder().applyMutation(getConfigurationSetRequest).build());
}
/**
*
* 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.
*
*
* @param getConfigurationSetEventDestinationsRequest
* A request to obtain information about the event destinations for a configuration set.
* @return Result of the GetConfigurationSetEventDestinations operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetConfigurationSetEventDestinations
* @see AWS API Documentation
*/
default GetConfigurationSetEventDestinationsResponse getConfigurationSetEventDestinations(
GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link GetConfigurationSetEventDestinationsRequest.Builder} avoiding the need to create one manually via
* {@link GetConfigurationSetEventDestinationsRequest#builder()}
*
*
* @param getConfigurationSetEventDestinationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetConfigurationSetEventDestinationsRequest.Builder}
* to create a request. A request to obtain information about the event destinations for a configuration set.
* @return Result of the GetConfigurationSetEventDestinations operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetConfigurationSetEventDestinations
* @see AWS API Documentation
*/
default GetConfigurationSetEventDestinationsResponse getConfigurationSetEventDestinations(
Consumer getConfigurationSetEventDestinationsRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest.builder()
.applyMutation(getConfigurationSetEventDestinationsRequest).build());
}
/**
*
* 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.
*
*
* @param getDedicatedIpRequest
* A request to obtain more information about a dedicated IP address.
* @return Result of the GetDedicatedIp operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDedicatedIp
* @see AWS
* API Documentation
*/
default GetDedicatedIpResponse getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest) throws TooManyRequestsException,
NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetDedicatedIpRequest.Builder} avoiding the need to
* create one manually via {@link GetDedicatedIpRequest#builder()}
*
*
* @param getDedicatedIpRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpRequest.Builder} to create a
* request. A request to obtain more information about a dedicated IP address.
* @return Result of the GetDedicatedIp operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDedicatedIp
* @see AWS
* API Documentation
*/
default GetDedicatedIpResponse getDedicatedIp(Consumer getDedicatedIpRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return getDedicatedIp(GetDedicatedIpRequest.builder().applyMutation(getDedicatedIpRequest).build());
}
/**
*
* List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
*
*
* @param getDedicatedIpsRequest
* A request to obtain more information about dedicated IP pools.
* @return Result of the GetDedicatedIps operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDedicatedIps
* @see AWS API Documentation
*/
default GetDedicatedIpsResponse getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
*
*
*
* This is a convenience which creates an instance of the {@link GetDedicatedIpsRequest.Builder} avoiding the need
* to create one manually via {@link GetDedicatedIpsRequest#builder()}
*
*
* @param getDedicatedIpsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest.Builder} to create a
* request. A request to obtain more information about dedicated IP pools.
* @return Result of the GetDedicatedIps operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDedicatedIps
* @see AWS API Documentation
*/
default GetDedicatedIpsResponse getDedicatedIps(Consumer getDedicatedIpsRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return getDedicatedIps(GetDedicatedIpsRequest.builder().applyMutation(getDedicatedIpsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client
* .getDedicatedIpsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDedicatedIps(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest)}
* operation.
*
*
* @param getDedicatedIpsRequest
* A request to obtain more information about dedicated IP pools.
* @return 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.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDedicatedIps
* @see AWS API Documentation
*/
default GetDedicatedIpsIterable getDedicatedIpsPaginator(GetDedicatedIpsRequest getDedicatedIpsRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return new GetDedicatedIpsIterable(this, getDedicatedIpsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client
* .getDedicatedIpsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.GetDedicatedIpsIterable responses = client.getDedicatedIpsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getDedicatedIps(software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetDedicatedIpsRequest.Builder} avoiding the need
* to create one manually via {@link GetDedicatedIpsRequest#builder()}
*
*
* @param getDedicatedIpsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetDedicatedIpsRequest.Builder} to create a
* request. A request to obtain more information about dedicated IP pools.
* @return 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.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDedicatedIps
* @see AWS API Documentation
*/
default GetDedicatedIpsIterable getDedicatedIpsPaginator(Consumer getDedicatedIpsRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return getDedicatedIpsPaginator(GetDedicatedIpsRequest.builder().applyMutation(getDedicatedIpsRequest).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Result of the GetDeliverabilityDashboardOptions operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDeliverabilityDashboardOptions
* @see AWS API Documentation
*/
default GetDeliverabilityDashboardOptionsResponse getDeliverabilityDashboardOptions(
GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest) throws TooManyRequestsException,
LimitExceededException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetDeliverabilityDashboardOptionsRequest.Builder}
* avoiding the need to create one manually via {@link GetDeliverabilityDashboardOptionsRequest#builder()}
*
*
* @param getDeliverabilityDashboardOptionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetDeliverabilityDashboardOptionsRequest.Builder}
* to create a request. Retrieve information about the status of the Deliverability dashboard for your Amazon
* Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation,
* deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You
* also gain the ability to perform predictive inbox placement tests.
*
* When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other
* fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a
* Deliverability dashboard subscription, see Amazon
* Pinpoint Pricing.
* @return Result of the GetDeliverabilityDashboardOptions operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDeliverabilityDashboardOptions
* @see AWS API Documentation
*/
default GetDeliverabilityDashboardOptionsResponse getDeliverabilityDashboardOptions(
Consumer getDeliverabilityDashboardOptionsRequest)
throws TooManyRequestsException, LimitExceededException, BadRequestException, AwsServiceException,
SdkClientException, PinpointEmailException {
return getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest.builder()
.applyMutation(getDeliverabilityDashboardOptionsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the GetDeliverabilityDashboardOptions operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDeliverabilityDashboardOptions
* @see #getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest)
* @see AWS API Documentation
*/
default GetDeliverabilityDashboardOptionsResponse getDeliverabilityDashboardOptions() throws TooManyRequestsException,
LimitExceededException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest.builder().build());
}
/**
*
* Retrieve the results of a predictive inbox placement test.
*
*
* @param getDeliverabilityTestReportRequest
* A request to retrieve the results of a predictive inbox placement test.
* @return Result of the GetDeliverabilityTestReport operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDeliverabilityTestReport
* @see AWS API Documentation
*/
default GetDeliverabilityTestReportResponse getDeliverabilityTestReport(
GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest) throws TooManyRequestsException,
NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieve the results of a predictive inbox placement test.
*
*
*
* This is a convenience which creates an instance of the {@link GetDeliverabilityTestReportRequest.Builder}
* avoiding the need to create one manually via {@link GetDeliverabilityTestReportRequest#builder()}
*
*
* @param getDeliverabilityTestReportRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetDeliverabilityTestReportRequest.Builder} to
* create a request. A request to retrieve the results of a predictive inbox placement test.
* @return Result of the GetDeliverabilityTestReport operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDeliverabilityTestReport
* @see AWS API Documentation
*/
default GetDeliverabilityTestReportResponse getDeliverabilityTestReport(
Consumer getDeliverabilityTestReportRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return getDeliverabilityTestReport(GetDeliverabilityTestReportRequest.builder()
.applyMutation(getDeliverabilityTestReportRequest).build());
}
/**
*
* Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the
* campaign sent email by using a domain that the Deliverability dashboard is enabled for (
* PutDeliverabilityDashboardOption operation).
*
*
* @param getDomainDeliverabilityCampaignRequest
* Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only
* if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
* PutDeliverabilityDashboardOption operation).
* @return Result of the GetDomainDeliverabilityCampaign operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDomainDeliverabilityCampaign
* @see AWS API Documentation
*/
default GetDomainDeliverabilityCampaignResponse getDomainDeliverabilityCampaign(
GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest) throws TooManyRequestsException,
BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the
* campaign sent email by using a domain that the Deliverability dashboard is enabled for (
* PutDeliverabilityDashboardOption operation).
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainDeliverabilityCampaignRequest.Builder}
* avoiding the need to create one manually via {@link GetDomainDeliverabilityCampaignRequest#builder()}
*
*
* @param getDomainDeliverabilityCampaignRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetDomainDeliverabilityCampaignRequest.Builder}
* to create a request. Retrieve all the deliverability data for a specific campaign. This data is available
* for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is
* enabled for (PutDeliverabilityDashboardOption operation).
* @return Result of the GetDomainDeliverabilityCampaign operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDomainDeliverabilityCampaign
* @see AWS API Documentation
*/
default GetDomainDeliverabilityCampaignResponse getDomainDeliverabilityCampaign(
Consumer getDomainDeliverabilityCampaignRequest)
throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException,
PinpointEmailException {
return getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest.builder()
.applyMutation(getDomainDeliverabilityCampaignRequest).build());
}
/**
*
* Retrieve inbox placement and engagement rates for the domains that you use to send email.
*
*
* @param getDomainStatisticsReportRequest
* A request to obtain deliverability metrics for a domain.
* @return Result of the GetDomainStatisticsReport operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDomainStatisticsReport
* @see AWS API Documentation
*/
default GetDomainStatisticsReportResponse getDomainStatisticsReport(
GetDomainStatisticsReportRequest getDomainStatisticsReportRequest) throws TooManyRequestsException,
NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetDomainStatisticsReportRequest.Builder} avoiding
* the need to create one manually via {@link GetDomainStatisticsReportRequest#builder()}
*
*
* @param getDomainStatisticsReportRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetDomainStatisticsReportRequest.Builder} to
* create a request. A request to obtain deliverability metrics for a domain.
* @return Result of the GetDomainStatisticsReport operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetDomainStatisticsReport
* @see AWS API Documentation
*/
default GetDomainStatisticsReportResponse getDomainStatisticsReport(
Consumer getDomainStatisticsReportRequest) throws TooManyRequestsException,
NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return getDomainStatisticsReport(GetDomainStatisticsReportRequest.builder()
.applyMutation(getDomainStatisticsReportRequest).build());
}
/**
*
* 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.
*
*
* @param getEmailIdentityRequest
* A request to return details about an email identity.
* @return Result of the GetEmailIdentity operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetEmailIdentity
* @see AWS API Documentation
*/
default GetEmailIdentityResponse getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetEmailIdentityRequest.Builder} avoiding the need
* to create one manually via {@link GetEmailIdentityRequest#builder()}
*
*
* @param getEmailIdentityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.GetEmailIdentityRequest.Builder} to create a
* request. A request to return details about an email identity.
* @return Result of the GetEmailIdentity operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.GetEmailIdentity
* @see AWS API Documentation
*/
default GetEmailIdentityResponse getEmailIdentity(Consumer getEmailIdentityRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return getEmailIdentity(GetEmailIdentityRequest.builder().applyMutation(getEmailIdentityRequest).build());
}
/**
*
* 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.
*
*
* @param listConfigurationSetsRequest
* A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS
* Region.
* @return Result of the ListConfigurationSets operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListConfigurationSets
* @see AWS API Documentation
*/
default ListConfigurationSetsResponse listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListConfigurationSetsRequest.Builder} avoiding the
* need to create one manually via {@link ListConfigurationSetsRequest#builder()}
*
*
* @param listConfigurationSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest.Builder} to create
* a request. A request to obtain a list of configuration sets for your Amazon Pinpoint account in the
* current AWS Region.
* @return Result of the ListConfigurationSets operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListConfigurationSets
* @see AWS API Documentation
*/
default ListConfigurationSetsResponse listConfigurationSets(
Consumer listConfigurationSetsRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return listConfigurationSets(ListConfigurationSetsRequest.builder().applyMutation(listConfigurationSetsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client
* .listConfigurationSetsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listConfigurationSets(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest)}
* operation.
*
*
* @param listConfigurationSetsRequest
* A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS
* Region.
* @return 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.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListConfigurationSets
* @see AWS API Documentation
*/
default ListConfigurationSetsIterable listConfigurationSetsPaginator(ListConfigurationSetsRequest listConfigurationSetsRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return new ListConfigurationSetsIterable(this, listConfigurationSetsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client
* .listConfigurationSetsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListConfigurationSetsIterable responses = client.listConfigurationSetsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listConfigurationSets(software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListConfigurationSetsRequest.Builder} avoiding the
* need to create one manually via {@link ListConfigurationSetsRequest#builder()}
*
*
* @param listConfigurationSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListConfigurationSetsRequest.Builder} to create
* a request. A request to obtain a list of configuration sets for your Amazon Pinpoint account in the
* current AWS Region.
* @return 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.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListConfigurationSets
* @see AWS API Documentation
*/
default ListConfigurationSetsIterable listConfigurationSetsPaginator(
Consumer listConfigurationSetsRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return listConfigurationSetsPaginator(ListConfigurationSetsRequest.builder().applyMutation(listConfigurationSetsRequest)
.build());
}
/**
*
* List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
*
*
* @param listDedicatedIpPoolsRequest
* A request to obtain a list of dedicated IP pools.
* @return Result of the ListDedicatedIpPools operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDedicatedIpPools
* @see AWS API Documentation
*/
default ListDedicatedIpPoolsResponse listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDedicatedIpPoolsRequest.Builder} avoiding the
* need to create one manually via {@link ListDedicatedIpPoolsRequest#builder()}
*
*
* @param listDedicatedIpPoolsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest.Builder} to create
* a request. A request to obtain a list of dedicated IP pools.
* @return Result of the ListDedicatedIpPools operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDedicatedIpPools
* @see AWS API Documentation
*/
default ListDedicatedIpPoolsResponse listDedicatedIpPools(
Consumer listDedicatedIpPoolsRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return listDedicatedIpPools(ListDedicatedIpPoolsRequest.builder().applyMutation(listDedicatedIpPoolsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client
* .listDedicatedIpPoolsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDedicatedIpPools(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest)}
* operation.
*
*
* @param listDedicatedIpPoolsRequest
* A request to obtain a list of dedicated IP pools.
* @return 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.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDedicatedIpPools
* @see AWS API Documentation
*/
default ListDedicatedIpPoolsIterable listDedicatedIpPoolsPaginator(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return new ListDedicatedIpPoolsIterable(this, listDedicatedIpPoolsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client
* .listDedicatedIpPoolsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDedicatedIpPoolsIterable responses = client.listDedicatedIpPoolsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDedicatedIpPools(software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDedicatedIpPoolsRequest.Builder} avoiding the
* need to create one manually via {@link ListDedicatedIpPoolsRequest#builder()}
*
*
* @param listDedicatedIpPoolsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListDedicatedIpPoolsRequest.Builder} to create
* a request. A request to obtain a list of dedicated IP pools.
* @return 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.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDedicatedIpPools
* @see AWS API Documentation
*/
default ListDedicatedIpPoolsIterable listDedicatedIpPoolsPaginator(
Consumer listDedicatedIpPoolsRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return listDedicatedIpPoolsPaginator(ListDedicatedIpPoolsRequest.builder().applyMutation(listDedicatedIpPoolsRequest)
.build());
}
/**
*
* Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For
* predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport
* operation to view the results.
*
*
* @param listDeliverabilityTestReportsRequest
* A request to list all of the predictive inbox placement tests that you've performed.
* @return Result of the ListDeliverabilityTestReports operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDeliverabilityTestReports
* @see AWS API Documentation
*/
default ListDeliverabilityTestReportsResponse listDeliverabilityTestReports(
ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) throws TooManyRequestsException,
NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For
* predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport
* operation to view the results.
*
*
*
* This is a convenience which creates an instance of the {@link ListDeliverabilityTestReportsRequest.Builder}
* avoiding the need to create one manually via {@link ListDeliverabilityTestReportsRequest#builder()}
*
*
* @param listDeliverabilityTestReportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest.Builder}
* to create a request. A request to list all of the predictive inbox placement tests that you've performed.
* @return Result of the ListDeliverabilityTestReports operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDeliverabilityTestReports
* @see AWS API Documentation
*/
default ListDeliverabilityTestReportsResponse listDeliverabilityTestReports(
Consumer listDeliverabilityTestReportsRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest.builder()
.applyMutation(listDeliverabilityTestReportsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client
* .listDeliverabilityTestReportsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDeliverabilityTestReports(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest)}
* operation.
*
*
* @param listDeliverabilityTestReportsRequest
* A request to list all of the predictive inbox placement tests that you've performed.
* @return 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.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDeliverabilityTestReports
* @see AWS API Documentation
*/
default ListDeliverabilityTestReportsIterable listDeliverabilityTestReportsPaginator(
ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest) throws TooManyRequestsException,
NotFoundException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return new ListDeliverabilityTestReportsIterable(this, listDeliverabilityTestReportsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client
* .listDeliverabilityTestReportsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDeliverabilityTestReportsIterable responses = client.listDeliverabilityTestReportsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDeliverabilityTestReports(software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDeliverabilityTestReportsRequest.Builder}
* avoiding the need to create one manually via {@link ListDeliverabilityTestReportsRequest#builder()}
*
*
* @param listDeliverabilityTestReportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListDeliverabilityTestReportsRequest.Builder}
* to create a request. A request to list all of the predictive inbox placement tests that you've performed.
* @return 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.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDeliverabilityTestReports
* @see AWS API Documentation
*/
default ListDeliverabilityTestReportsIterable listDeliverabilityTestReportsPaginator(
Consumer listDeliverabilityTestReportsRequest)
throws TooManyRequestsException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return listDeliverabilityTestReportsPaginator(ListDeliverabilityTestReportsRequest.builder()
.applyMutation(listDeliverabilityTestReportsRequest).build());
}
/**
*
* Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
* time range. This data is available for a domain only if you enabled the Deliverability dashboard (
* PutDeliverabilityDashboardOption operation) for the domain.
*
*
* @param listDomainDeliverabilityCampaignsRequest
* Retrieve deliverability data for all the campaigns that used a specific domain to send email during a
* specified time range. This data is available for a domain only if you enabled the Deliverability dashboard
* (PutDeliverabilityDashboardOption operation) for the domain.
* @return Result of the ListDomainDeliverabilityCampaigns operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDomainDeliverabilityCampaigns
* @see AWS API Documentation
*/
default ListDomainDeliverabilityCampaignsResponse listDomainDeliverabilityCampaigns(
ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) throws TooManyRequestsException,
BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
* time range. This data is available for a domain only if you enabled the Deliverability dashboard (
* PutDeliverabilityDashboardOption operation) for the domain.
*
*
*
* This is a convenience which creates an instance of the {@link ListDomainDeliverabilityCampaignsRequest.Builder}
* avoiding the need to create one manually via {@link ListDomainDeliverabilityCampaignsRequest#builder()}
*
*
* @param listDomainDeliverabilityCampaignsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest.Builder}
* to create a request. Retrieve deliverability data for all the campaigns that used a specific domain to
* send email during a specified time range. This data is available for a domain only if you enabled the
* Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.
* @return Result of the ListDomainDeliverabilityCampaigns operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDomainDeliverabilityCampaigns
* @see AWS API Documentation
*/
default ListDomainDeliverabilityCampaignsResponse listDomainDeliverabilityCampaigns(
Consumer listDomainDeliverabilityCampaignsRequest)
throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException,
PinpointEmailException {
return listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest.builder()
.applyMutation(listDomainDeliverabilityCampaignsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client
* .listDomainDeliverabilityCampaignsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDomainDeliverabilityCampaigns(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest)}
* operation.
*
*
* @param listDomainDeliverabilityCampaignsRequest
* Retrieve deliverability data for all the campaigns that used a specific domain to send email during a
* specified time range. This data is available for a domain only if you enabled the Deliverability dashboard
* (PutDeliverabilityDashboardOption operation) for the domain.
* @return 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.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDomainDeliverabilityCampaigns
* @see AWS API Documentation
*/
default ListDomainDeliverabilityCampaignsIterable listDomainDeliverabilityCampaignsPaginator(
ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest) throws TooManyRequestsException,
BadRequestException, NotFoundException, AwsServiceException, SdkClientException, PinpointEmailException {
return new ListDomainDeliverabilityCampaignsIterable(this, listDomainDeliverabilityCampaignsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client
* .listDomainDeliverabilityCampaignsPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListDomainDeliverabilityCampaignsIterable responses = client.listDomainDeliverabilityCampaignsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDomainDeliverabilityCampaigns(software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDomainDeliverabilityCampaignsRequest.Builder}
* avoiding the need to create one manually via {@link ListDomainDeliverabilityCampaignsRequest#builder()}
*
*
* @param listDomainDeliverabilityCampaignsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListDomainDeliverabilityCampaignsRequest.Builder}
* to create a request. Retrieve deliverability data for all the campaigns that used a specific domain to
* send email during a specified time range. This data is available for a domain only if you enabled the
* Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.
* @return 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.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListDomainDeliverabilityCampaigns
* @see AWS API Documentation
*/
default ListDomainDeliverabilityCampaignsIterable listDomainDeliverabilityCampaignsPaginator(
Consumer listDomainDeliverabilityCampaignsRequest)
throws TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException,
PinpointEmailException {
return listDomainDeliverabilityCampaignsPaginator(ListDomainDeliverabilityCampaignsRequest.builder()
.applyMutation(listDomainDeliverabilityCampaignsRequest).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Result of the ListEmailIdentities operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListEmailIdentities
* @see AWS API Documentation
*/
default ListEmailIdentitiesResponse listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListEmailIdentitiesRequest.Builder} avoiding the
* need to create one manually via {@link ListEmailIdentitiesRequest#builder()}
*
*
* @param listEmailIdentitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest.Builder} to create a
* request. A request to list all of the email identities associated with your Amazon Pinpoint account. This
* list includes identities that you've already verified, identities that are unverified, and identities that
* were verified in the past, but are no longer verified.
* @return Result of the ListEmailIdentities operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListEmailIdentities
* @see AWS API Documentation
*/
default ListEmailIdentitiesResponse listEmailIdentities(
Consumer listEmailIdentitiesRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return listEmailIdentities(ListEmailIdentitiesRequest.builder().applyMutation(listEmailIdentitiesRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client
* .listEmailIdentitiesPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEmailIdentities(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest)}
* operation.
*
*
* @param 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.
* @return 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.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListEmailIdentities
* @see AWS API Documentation
*/
default ListEmailIdentitiesIterable listEmailIdentitiesPaginator(ListEmailIdentitiesRequest listEmailIdentitiesRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return new ListEmailIdentitiesIterable(this, listEmailIdentitiesRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client
* .listEmailIdentitiesPaginator(request);
* for (software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.pinpointemail.paginators.ListEmailIdentitiesIterable responses = client.listEmailIdentitiesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of PageSize won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEmailIdentities(software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListEmailIdentitiesRequest.Builder} avoiding the
* need to create one manually via {@link ListEmailIdentitiesRequest#builder()}
*
*
* @param listEmailIdentitiesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListEmailIdentitiesRequest.Builder} to create a
* request. A request to list all of the email identities associated with your Amazon Pinpoint account. This
* list includes identities that you've already verified, identities that are unverified, and identities that
* were verified in the past, but are no longer verified.
* @return 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.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListEmailIdentities
* @see AWS API Documentation
*/
default ListEmailIdentitiesIterable listEmailIdentitiesPaginator(
Consumer listEmailIdentitiesRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return listEmailIdentitiesPaginator(ListEmailIdentitiesRequest.builder().applyMutation(listEmailIdentitiesRequest)
.build());
}
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws BadRequestException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException,
PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws BadRequestException,
NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointEmailException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Enable or disable the automatic warm-up feature for dedicated IP addresses.
*
*
* @param putAccountDedicatedIpWarmupAttributesRequest
* A request to enable or disable the automatic IP address warm-up feature.
* @return Result of the PutAccountDedicatedIpWarmupAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutAccountDedicatedIpWarmupAttributes
* @see AWS API Documentation
*/
default PutAccountDedicatedIpWarmupAttributesResponse putAccountDedicatedIpWarmupAttributes(
PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Enable or disable the automatic warm-up feature for dedicated IP addresses.
*
*
*
* This is a convenience which creates an instance of the
* {@link PutAccountDedicatedIpWarmupAttributesRequest.Builder} avoiding the need to create one manually via
* {@link PutAccountDedicatedIpWarmupAttributesRequest#builder()}
*
*
* @param putAccountDedicatedIpWarmupAttributesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutAccountDedicatedIpWarmupAttributesRequest.Builder}
* to create a request. A request to enable or disable the automatic IP address warm-up feature.
* @return Result of the PutAccountDedicatedIpWarmupAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutAccountDedicatedIpWarmupAttributes
* @see AWS API Documentation
*/
default PutAccountDedicatedIpWarmupAttributesResponse putAccountDedicatedIpWarmupAttributes(
Consumer putAccountDedicatedIpWarmupAttributesRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest.builder()
.applyMutation(putAccountDedicatedIpWarmupAttributesRequest).build());
}
/**
*
* Enable or disable the ability of your account to send email.
*
*
* @param putAccountSendingAttributesRequest
* A request to change the ability of your account to send email.
* @return Result of the PutAccountSendingAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutAccountSendingAttributes
* @see AWS API Documentation
*/
default PutAccountSendingAttributesResponse putAccountSendingAttributes(
PutAccountSendingAttributesRequest putAccountSendingAttributesRequest) throws TooManyRequestsException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Enable or disable the ability of your account to send email.
*
*
*
* This is a convenience which creates an instance of the {@link PutAccountSendingAttributesRequest.Builder}
* avoiding the need to create one manually via {@link PutAccountSendingAttributesRequest#builder()}
*
*
* @param putAccountSendingAttributesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutAccountSendingAttributesRequest.Builder} to
* create a request. A request to change the ability of your account to send email.
* @return Result of the PutAccountSendingAttributes operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutAccountSendingAttributes
* @see AWS API Documentation
*/
default PutAccountSendingAttributesResponse putAccountSendingAttributes(
Consumer putAccountSendingAttributesRequest)
throws TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return putAccountSendingAttributes(PutAccountSendingAttributesRequest.builder()
.applyMutation(putAccountSendingAttributesRequest).build());
}
/**
*
* 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.
*
*
* @param putConfigurationSetDeliveryOptionsRequest
* A request to associate a configuration set with a dedicated IP pool.
* @return Result of the PutConfigurationSetDeliveryOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutConfigurationSetDeliveryOptions
* @see AWS API Documentation
*/
default PutConfigurationSetDeliveryOptionsResponse putConfigurationSetDeliveryOptions(
PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutConfigurationSetDeliveryOptionsRequest.Builder}
* avoiding the need to create one manually via {@link PutConfigurationSetDeliveryOptionsRequest#builder()}
*
*
* @param putConfigurationSetDeliveryOptionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetDeliveryOptionsRequest.Builder}
* to create a request. A request to associate a configuration set with a dedicated IP pool.
* @return Result of the PutConfigurationSetDeliveryOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutConfigurationSetDeliveryOptions
* @see AWS API Documentation
*/
default PutConfigurationSetDeliveryOptionsResponse putConfigurationSetDeliveryOptions(
Consumer putConfigurationSetDeliveryOptionsRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest.builder()
.applyMutation(putConfigurationSetDeliveryOptionsRequest).build());
}
/**
*
* Enable or disable collection of reputation metrics for emails that you send using a particular configuration set
* in a specific AWS Region.
*
*
* @param putConfigurationSetReputationOptionsRequest
* A request to enable or disable tracking of reputation metrics for a configuration set.
* @return Result of the PutConfigurationSetReputationOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutConfigurationSetReputationOptions
* @see AWS API Documentation
*/
default PutConfigurationSetReputationOptionsResponse putConfigurationSetReputationOptions(
PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link PutConfigurationSetReputationOptionsRequest.Builder} avoiding the need to create one manually via
* {@link PutConfigurationSetReputationOptionsRequest#builder()}
*
*
* @param putConfigurationSetReputationOptionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetReputationOptionsRequest.Builder}
* to create a request. A request to enable or disable tracking of reputation metrics for a configuration
* set.
* @return Result of the PutConfigurationSetReputationOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutConfigurationSetReputationOptions
* @see AWS API Documentation
*/
default PutConfigurationSetReputationOptionsResponse putConfigurationSetReputationOptions(
Consumer putConfigurationSetReputationOptionsRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest.builder()
.applyMutation(putConfigurationSetReputationOptionsRequest).build());
}
/**
*
* Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
*
*
* @param putConfigurationSetSendingOptionsRequest
* A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific
* configuration set.
* @return Result of the PutConfigurationSetSendingOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutConfigurationSetSendingOptions
* @see AWS API Documentation
*/
default PutConfigurationSetSendingOptionsResponse putConfigurationSetSendingOptions(
PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutConfigurationSetSendingOptionsRequest.Builder}
* avoiding the need to create one manually via {@link PutConfigurationSetSendingOptionsRequest#builder()}
*
*
* @param putConfigurationSetSendingOptionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetSendingOptionsRequest.Builder}
* to create a request. A request to enable or disable the ability of Amazon Pinpoint to send emails that use
* a specific configuration set.
* @return Result of the PutConfigurationSetSendingOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutConfigurationSetSendingOptions
* @see AWS API Documentation
*/
default PutConfigurationSetSendingOptionsResponse putConfigurationSetSendingOptions(
Consumer putConfigurationSetSendingOptionsRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest.builder()
.applyMutation(putConfigurationSetSendingOptionsRequest).build());
}
/**
*
* Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
*
*
* @param putConfigurationSetTrackingOptionsRequest
* A request to add a custom domain for tracking open and click events to a configuration set.
* @return Result of the PutConfigurationSetTrackingOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutConfigurationSetTrackingOptions
* @see AWS API Documentation
*/
default PutConfigurationSetTrackingOptionsResponse putConfigurationSetTrackingOptions(
PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutConfigurationSetTrackingOptionsRequest.Builder}
* avoiding the need to create one manually via {@link PutConfigurationSetTrackingOptionsRequest#builder()}
*
*
* @param putConfigurationSetTrackingOptionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutConfigurationSetTrackingOptionsRequest.Builder}
* to create a request. A request to add a custom domain for tracking open and click events to a
* configuration set.
* @return Result of the PutConfigurationSetTrackingOptions operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutConfigurationSetTrackingOptions
* @see AWS API Documentation
*/
default PutConfigurationSetTrackingOptionsResponse putConfigurationSetTrackingOptions(
Consumer putConfigurationSetTrackingOptionsRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest.builder()
.applyMutation(putConfigurationSetTrackingOptionsRequest).build());
}
/**
*
* Move a dedicated IP address to an existing dedicated IP pool.
*
*
*
* The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint
* account.
*
*
* The dedicated IP pool you specify must already exist. You can create a new pool by using the
* CreateDedicatedIpPool operation.
*
*
*
* @param putDedicatedIpInPoolRequest
* A request to move a dedicated IP address to a dedicated IP pool.
* @return Result of the PutDedicatedIpInPool operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutDedicatedIpInPool
* @see AWS API Documentation
*/
default PutDedicatedIpInPoolResponse putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Move a dedicated IP address to an existing dedicated IP pool.
*
*
*
* The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint
* account.
*
*
* The dedicated IP pool you specify must already exist. You can create a new pool by using the
* CreateDedicatedIpPool operation.
*
*
*
* This is a convenience which creates an instance of the {@link PutDedicatedIpInPoolRequest.Builder} avoiding the
* need to create one manually via {@link PutDedicatedIpInPoolRequest#builder()}
*
*
* @param putDedicatedIpInPoolRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutDedicatedIpInPoolRequest.Builder} to create
* a request. A request to move a dedicated IP address to a dedicated IP pool.
* @return Result of the PutDedicatedIpInPool operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutDedicatedIpInPool
* @see AWS API Documentation
*/
default PutDedicatedIpInPoolResponse putDedicatedIpInPool(
Consumer putDedicatedIpInPoolRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return putDedicatedIpInPool(PutDedicatedIpInPoolRequest.builder().applyMutation(putDedicatedIpInPoolRequest).build());
}
/**
*
*
* @param 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.
* @return Result of the PutDedicatedIpWarmupAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutDedicatedIpWarmupAttributes
* @see AWS API Documentation
*/
default PutDedicatedIpWarmupAttributesResponse putDedicatedIpWarmupAttributes(
PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
*
*
* This is a convenience which creates an instance of the {@link PutDedicatedIpWarmupAttributesRequest.Builder}
* avoiding the need to create one manually via {@link PutDedicatedIpWarmupAttributesRequest#builder()}
*
*
* @param putDedicatedIpWarmupAttributesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutDedicatedIpWarmupAttributesRequest.Builder}
* to create a request. A request to change the warm-up attributes for a dedicated IP address. This operation
* is useful when you want to resume the warm-up process for an existing IP address.
* @return Result of the PutDedicatedIpWarmupAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutDedicatedIpWarmupAttributes
* @see AWS API Documentation
*/
default PutDedicatedIpWarmupAttributesResponse putDedicatedIpWarmupAttributes(
Consumer putDedicatedIpWarmupAttributesRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest.builder()
.applyMutation(putDedicatedIpWarmupAttributesRequest).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Result of the PutDeliverabilityDashboardOption operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutDeliverabilityDashboardOption
* @see AWS API Documentation
*/
default PutDeliverabilityDashboardOptionResponse putDeliverabilityDashboardOption(
PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest) throws AlreadyExistsException,
NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, AwsServiceException,
SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutDeliverabilityDashboardOptionRequest.Builder}
* avoiding the need to create one manually via {@link PutDeliverabilityDashboardOptionRequest#builder()}
*
*
* @param putDeliverabilityDashboardOptionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutDeliverabilityDashboardOptionRequest.Builder}
* to create a request. Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When
* you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics
* for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform
* predictive inbox placement tests.
*
* When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other
* fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a
* Deliverability dashboard subscription, see Amazon
* Pinpoint Pricing.
* @return Result of the PutDeliverabilityDashboardOption operation returned by the service.
* @throws AlreadyExistsException
* The resource specified in your request already exists.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutDeliverabilityDashboardOption
* @see AWS API Documentation
*/
default PutDeliverabilityDashboardOptionResponse putDeliverabilityDashboardOption(
Consumer putDeliverabilityDashboardOptionRequest)
throws AlreadyExistsException, NotFoundException, TooManyRequestsException, LimitExceededException,
BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
return putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest.builder()
.applyMutation(putDeliverabilityDashboardOptionRequest).build());
}
/**
*
* Used to enable or disable DKIM authentication for an email identity.
*
*
* @param putEmailIdentityDkimAttributesRequest
* A request to enable or disable DKIM signing of email that you send from an email identity.
* @return Result of the PutEmailIdentityDkimAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutEmailIdentityDkimAttributes
* @see AWS API Documentation
*/
default PutEmailIdentityDkimAttributesResponse putEmailIdentityDkimAttributes(
PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Used to enable or disable DKIM authentication for an email identity.
*
*
*
* This is a convenience which creates an instance of the {@link PutEmailIdentityDkimAttributesRequest.Builder}
* avoiding the need to create one manually via {@link PutEmailIdentityDkimAttributesRequest#builder()}
*
*
* @param putEmailIdentityDkimAttributesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityDkimAttributesRequest.Builder}
* to create a request. A request to enable or disable DKIM signing of email that you send from an email
* identity.
* @return Result of the PutEmailIdentityDkimAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutEmailIdentityDkimAttributes
* @see AWS API Documentation
*/
default PutEmailIdentityDkimAttributesResponse putEmailIdentityDkimAttributes(
Consumer putEmailIdentityDkimAttributesRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest.builder()
.applyMutation(putEmailIdentityDkimAttributesRequest).build());
}
/**
*
* 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).
*
*
* @param putEmailIdentityFeedbackAttributesRequest
* A request to set the attributes that control how bounce and complaint events are processed.
* @return Result of the PutEmailIdentityFeedbackAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutEmailIdentityFeedbackAttributes
* @see AWS API Documentation
*/
default PutEmailIdentityFeedbackAttributesResponse putEmailIdentityFeedbackAttributes(
PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutEmailIdentityFeedbackAttributesRequest.Builder}
* avoiding the need to create one manually via {@link PutEmailIdentityFeedbackAttributesRequest#builder()}
*
*
* @param putEmailIdentityFeedbackAttributesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityFeedbackAttributesRequest.Builder}
* to create a request. A request to set the attributes that control how bounce and complaint events are
* processed.
* @return Result of the PutEmailIdentityFeedbackAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutEmailIdentityFeedbackAttributes
* @see AWS API Documentation
*/
default PutEmailIdentityFeedbackAttributesResponse putEmailIdentityFeedbackAttributes(
Consumer putEmailIdentityFeedbackAttributesRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest.builder()
.applyMutation(putEmailIdentityFeedbackAttributesRequest).build());
}
/**
*
* Used to enable or disable the custom Mail-From domain configuration for an email identity.
*
*
* @param putEmailIdentityMailFromAttributesRequest
* A request to configure the custom MAIL FROM domain for a verified identity.
* @return Result of the PutEmailIdentityMailFromAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutEmailIdentityMailFromAttributes
* @see AWS API Documentation
*/
default PutEmailIdentityMailFromAttributesResponse putEmailIdentityMailFromAttributes(
PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest) throws NotFoundException,
TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PutEmailIdentityMailFromAttributesRequest.Builder}
* avoiding the need to create one manually via {@link PutEmailIdentityMailFromAttributesRequest#builder()}
*
*
* @param putEmailIdentityMailFromAttributesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityMailFromAttributesRequest.Builder}
* to create a request. A request to configure the custom MAIL FROM domain for a verified identity.
* @return Result of the PutEmailIdentityMailFromAttributes operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.PutEmailIdentityMailFromAttributes
* @see AWS API Documentation
*/
default PutEmailIdentityMailFromAttributesResponse putEmailIdentityMailFromAttributes(
Consumer putEmailIdentityMailFromAttributesRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest.builder()
.applyMutation(putEmailIdentityMailFromAttributesRequest).build());
}
/**
*
* 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.
*
*
*
*
* @param sendEmailRequest
* A request to send an email message.
* @return Result of the SendEmail operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws AccountSuspendedException
* The message can't be sent because the account's ability to send email has been permanently restricted.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.SendEmail
* @see AWS API
* Documentation
*/
default SendEmailResponse sendEmail(SendEmailRequest sendEmailRequest) throws TooManyRequestsException,
LimitExceededException, AccountSuspendedException, SendingPausedException, MessageRejectedException,
MailFromDomainNotVerifiedException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SendEmailRequest.Builder} avoiding the need to
* create one manually via {@link SendEmailRequest#builder()}
*
*
* @param sendEmailRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.SendEmailRequest.Builder} to create a request.
* A request to send an email message.
* @return Result of the SendEmail operation returned by the service.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws LimitExceededException
* There are too many instances of the specified resource type.
* @throws AccountSuspendedException
* The message can't be sent because the account's ability to send email has been permanently restricted.
* @throws SendingPausedException
* The message can't be sent because the account's ability to send email is currently paused.
* @throws MessageRejectedException
* The message can't be sent because it contains invalid content.
* @throws MailFromDomainNotVerifiedException
* The message can't be sent because the sending domain isn't verified.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.SendEmail
* @see AWS API
* Documentation
*/
default SendEmailResponse sendEmail(Consumer sendEmailRequest) throws TooManyRequestsException,
LimitExceededException, AccountSuspendedException, SendingPausedException, MessageRejectedException,
MailFromDomainNotVerifiedException, NotFoundException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return sendEmail(SendEmailRequest.builder().applyMutation(sendEmailRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.TagResource
* @see AWS
* API Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException,
ConcurrentModificationException, NotFoundException, TooManyRequestsException, AwsServiceException,
SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.TagResourceRequest.Builder} to create a
* request.
* @return Result of the TagResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.TagResource
* @see AWS
* API Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest) throws BadRequestException,
ConcurrentModificationException, NotFoundException, TooManyRequestsException, AwsServiceException,
SdkClientException, PinpointEmailException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Remove one or more tags (keys and values) from a specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.UntagResource
* @see AWS
* API Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException,
ConcurrentModificationException, NotFoundException, TooManyRequestsException, AwsServiceException,
SdkClientException, PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* Remove one or more tags (keys and values) from a specified resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.UntagResourceRequest.Builder} to create a
* request.
* @return Result of the UntagResource operation returned by the service.
* @throws BadRequestException
* The input you provided is invalid.
* @throws ConcurrentModificationException
* The resource is being modified by another operation or thread.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.UntagResource
* @see AWS
* API Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws BadRequestException, ConcurrentModificationException, NotFoundException, TooManyRequestsException,
AwsServiceException, SdkClientException, PinpointEmailException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* 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.
*
*
* @param updateConfigurationSetEventDestinationRequest
* A request to change the settings for an event destination for a configuration set.
* @return Result of the UpdateConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.UpdateConfigurationSetEventDestination
* @see AWS API Documentation
*/
default UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(
UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link UpdateConfigurationSetEventDestinationRequest.Builder} avoiding the need to create one manually via
* {@link UpdateConfigurationSetEventDestinationRequest#builder()}
*
*
* @param updateConfigurationSetEventDestinationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.UpdateConfigurationSetEventDestinationRequest.Builder}
* to create a request. A request to change the settings for an event destination for a configuration set.
* @return Result of the UpdateConfigurationSetEventDestination operation returned by the service.
* @throws NotFoundException
* The resource you attempted to access doesn't exist.
* @throws TooManyRequestsException
* Too many requests have been made to the operation.
* @throws BadRequestException
* The input you provided is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws PinpointEmailException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample PinpointEmailClient.UpdateConfigurationSetEventDestination
* @see AWS API Documentation
*/
default UpdateConfigurationSetEventDestinationResponse updateConfigurationSetEventDestination(
Consumer updateConfigurationSetEventDestinationRequest)
throws NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException,
PinpointEmailException {
return updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest.builder()
.applyMutation(updateConfigurationSetEventDestinationRequest).build());
}
/**
* Create a {@link PinpointEmailClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static PinpointEmailClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link PinpointEmailClient}.
*/
static PinpointEmailClientBuilder builder() {
return new DefaultPinpointEmailClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default PinpointEmailServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}