Interface PinpointSmsVoiceV2Client
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, it's also helpful to 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 key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateOriginationIdentity
(Consumer<AssociateOriginationIdentityRequest.Builder> associateOriginationIdentityRequest) Associates the specified origination identity with a pool.associateOriginationIdentity
(AssociateOriginationIdentityRequest associateOriginationIdentityRequest) Associates the specified origination identity with a pool.builder()
Create a builder that can be used to configure and create aPinpointSmsVoiceV2Client
.static PinpointSmsVoiceV2Client
create()
Create aPinpointSmsVoiceV2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateConfigurationSetResponse
createConfigurationSet
(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) Creates a new configuration set.default CreateConfigurationSetResponse
createConfigurationSet
(CreateConfigurationSetRequest createConfigurationSetRequest) Creates a new configuration set.default CreateEventDestinationResponse
createEventDestination
(Consumer<CreateEventDestinationRequest.Builder> createEventDestinationRequest) Creates a new event destination in a configuration set.default CreateEventDestinationResponse
createEventDestination
(CreateEventDestinationRequest createEventDestinationRequest) Creates a new event destination in a configuration set.default CreateOptOutListResponse
createOptOutList
(Consumer<CreateOptOutListRequest.Builder> createOptOutListRequest) Creates a new opt-out list.default CreateOptOutListResponse
createOptOutList
(CreateOptOutListRequest createOptOutListRequest) Creates a new opt-out list.default CreatePoolResponse
createPool
(Consumer<CreatePoolRequest.Builder> createPoolRequest) Creates a new pool and associates the specified origination identity to the pool.default CreatePoolResponse
createPool
(CreatePoolRequest createPoolRequest) Creates a new pool and associates the specified origination identity to the pool.default DeleteConfigurationSetResponse
deleteConfigurationSet
(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) Deletes an existing configuration set.default DeleteConfigurationSetResponse
deleteConfigurationSet
(DeleteConfigurationSetRequest deleteConfigurationSetRequest) Deletes an existing configuration set.default DeleteDefaultMessageTypeResponse
deleteDefaultMessageType
(Consumer<DeleteDefaultMessageTypeRequest.Builder> deleteDefaultMessageTypeRequest) Deletes an existing default message type on a configuration set.default DeleteDefaultMessageTypeResponse
deleteDefaultMessageType
(DeleteDefaultMessageTypeRequest deleteDefaultMessageTypeRequest) Deletes an existing default message type on a configuration set.default DeleteDefaultSenderIdResponse
deleteDefaultSenderId
(Consumer<DeleteDefaultSenderIdRequest.Builder> deleteDefaultSenderIdRequest) Deletes an existing default sender ID on a configuration set.default DeleteDefaultSenderIdResponse
deleteDefaultSenderId
(DeleteDefaultSenderIdRequest deleteDefaultSenderIdRequest) Deletes an existing default sender ID on a configuration set.default DeleteEventDestinationResponse
deleteEventDestination
(Consumer<DeleteEventDestinationRequest.Builder> deleteEventDestinationRequest) Deletes an existing event destination.default DeleteEventDestinationResponse
deleteEventDestination
(DeleteEventDestinationRequest deleteEventDestinationRequest) Deletes an existing event destination.default DeleteKeywordResponse
deleteKeyword
(Consumer<DeleteKeywordRequest.Builder> deleteKeywordRequest) Deletes an existing keyword from an origination phone number or pool.default DeleteKeywordResponse
deleteKeyword
(DeleteKeywordRequest deleteKeywordRequest) Deletes an existing keyword from an origination phone number or pool.default DeleteOptedOutNumberResponse
deleteOptedOutNumber
(Consumer<DeleteOptedOutNumberRequest.Builder> deleteOptedOutNumberRequest) Deletes an existing opted out destination phone number from the specified opt-out list.default DeleteOptedOutNumberResponse
deleteOptedOutNumber
(DeleteOptedOutNumberRequest deleteOptedOutNumberRequest) Deletes an existing opted out destination phone number from the specified opt-out list.default DeleteOptOutListResponse
deleteOptOutList
(Consumer<DeleteOptOutListRequest.Builder> deleteOptOutListRequest) Deletes an existing opt-out list.default DeleteOptOutListResponse
deleteOptOutList
(DeleteOptOutListRequest deleteOptOutListRequest) Deletes an existing opt-out list.default DeletePoolResponse
deletePool
(Consumer<DeletePoolRequest.Builder> deletePoolRequest) Deletes an existing pool.default DeletePoolResponse
deletePool
(DeletePoolRequest deletePoolRequest) Deletes an existing pool.deleteTextMessageSpendLimitOverride
(Consumer<DeleteTextMessageSpendLimitOverrideRequest.Builder> deleteTextMessageSpendLimitOverrideRequest) Deletes an account-level monthly spending limit override for sending text messages.deleteTextMessageSpendLimitOverride
(DeleteTextMessageSpendLimitOverrideRequest deleteTextMessageSpendLimitOverrideRequest) Deletes an account-level monthly spending limit override for sending text messages.deleteVoiceMessageSpendLimitOverride
(Consumer<DeleteVoiceMessageSpendLimitOverrideRequest.Builder> deleteVoiceMessageSpendLimitOverrideRequest) Deletes an account level monthly spend limit override for sending voice messages.deleteVoiceMessageSpendLimitOverride
(DeleteVoiceMessageSpendLimitOverrideRequest deleteVoiceMessageSpendLimitOverrideRequest) Deletes an account level monthly spend limit override for sending voice messages.describeAccountAttributes
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Describes attributes of your Amazon Web Services account.describeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Describes attributes of your Amazon Web Services account.describeAccountAttributesPaginator
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Describes attributes of your Amazon Web Services account.describeAccountAttributesPaginator
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Describes attributes of your Amazon Web Services account.default DescribeAccountLimitsResponse
describeAccountLimits
(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account.default DescribeAccountLimitsResponse
describeAccountLimits
(DescribeAccountLimitsRequest describeAccountLimitsRequest) Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account.default DescribeAccountLimitsIterable
describeAccountLimitsPaginator
(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account.default DescribeAccountLimitsIterable
describeAccountLimitsPaginator
(DescribeAccountLimitsRequest describeAccountLimitsRequest) Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account.describeConfigurationSets
(Consumer<DescribeConfigurationSetsRequest.Builder> describeConfigurationSetsRequest) Describes the specified configuration sets or all in your account.describeConfigurationSets
(DescribeConfigurationSetsRequest describeConfigurationSetsRequest) Describes the specified configuration sets or all in your account.describeConfigurationSetsPaginator
(Consumer<DescribeConfigurationSetsRequest.Builder> describeConfigurationSetsRequest) Describes the specified configuration sets or all in your account.describeConfigurationSetsPaginator
(DescribeConfigurationSetsRequest describeConfigurationSetsRequest) Describes the specified configuration sets or all in your account.default DescribeKeywordsResponse
describeKeywords
(Consumer<DescribeKeywordsRequest.Builder> describeKeywordsRequest) Describes the specified keywords or all keywords on your origination phone number or pool.default DescribeKeywordsResponse
describeKeywords
(DescribeKeywordsRequest describeKeywordsRequest) Describes the specified keywords or all keywords on your origination phone number or pool.default DescribeKeywordsIterable
describeKeywordsPaginator
(Consumer<DescribeKeywordsRequest.Builder> describeKeywordsRequest) Describes the specified keywords or all keywords on your origination phone number or pool.default DescribeKeywordsIterable
describeKeywordsPaginator
(DescribeKeywordsRequest describeKeywordsRequest) Describes the specified keywords or all keywords on your origination phone number or pool.default DescribeOptedOutNumbersResponse
describeOptedOutNumbers
(Consumer<DescribeOptedOutNumbersRequest.Builder> describeOptedOutNumbersRequest) Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.default DescribeOptedOutNumbersResponse
describeOptedOutNumbers
(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest) Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.default DescribeOptedOutNumbersIterable
describeOptedOutNumbersPaginator
(Consumer<DescribeOptedOutNumbersRequest.Builder> describeOptedOutNumbersRequest) Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.default DescribeOptedOutNumbersIterable
describeOptedOutNumbersPaginator
(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest) Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.default DescribeOptOutListsResponse
describeOptOutLists
(Consumer<DescribeOptOutListsRequest.Builder> describeOptOutListsRequest) Describes the specified opt-out list or all opt-out lists in your account.default DescribeOptOutListsResponse
describeOptOutLists
(DescribeOptOutListsRequest describeOptOutListsRequest) Describes the specified opt-out list or all opt-out lists in your account.default DescribeOptOutListsIterable
describeOptOutListsPaginator
(Consumer<DescribeOptOutListsRequest.Builder> describeOptOutListsRequest) Describes the specified opt-out list or all opt-out lists in your account.default DescribeOptOutListsIterable
describeOptOutListsPaginator
(DescribeOptOutListsRequest describeOptOutListsRequest) Describes the specified opt-out list or all opt-out lists in your account.default DescribePhoneNumbersResponse
describePhoneNumbers
(Consumer<DescribePhoneNumbersRequest.Builder> describePhoneNumbersRequest) Describes the specified origination phone number, or all the phone numbers in your account.default DescribePhoneNumbersResponse
describePhoneNumbers
(DescribePhoneNumbersRequest describePhoneNumbersRequest) Describes the specified origination phone number, or all the phone numbers in your account.default DescribePhoneNumbersIterable
describePhoneNumbersPaginator
(Consumer<DescribePhoneNumbersRequest.Builder> describePhoneNumbersRequest) Describes the specified origination phone number, or all the phone numbers in your account.default DescribePhoneNumbersIterable
describePhoneNumbersPaginator
(DescribePhoneNumbersRequest describePhoneNumbersRequest) Describes the specified origination phone number, or all the phone numbers in your account.default DescribePoolsResponse
describePools
(Consumer<DescribePoolsRequest.Builder> describePoolsRequest) Retrieves the specified pools or all pools associated with your Amazon Web Services account.default DescribePoolsResponse
describePools
(DescribePoolsRequest describePoolsRequest) Retrieves the specified pools or all pools associated with your Amazon Web Services account.default DescribePoolsIterable
describePoolsPaginator
(Consumer<DescribePoolsRequest.Builder> describePoolsRequest) Retrieves the specified pools or all pools associated with your Amazon Web Services account.default DescribePoolsIterable
describePoolsPaginator
(DescribePoolsRequest describePoolsRequest) Retrieves the specified pools or all pools associated with your Amazon Web Services account.default DescribeSenderIdsResponse
describeSenderIds
(Consumer<DescribeSenderIdsRequest.Builder> describeSenderIdsRequest) Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.default DescribeSenderIdsResponse
describeSenderIds
(DescribeSenderIdsRequest describeSenderIdsRequest) Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.default DescribeSenderIdsIterable
describeSenderIdsPaginator
(Consumer<DescribeSenderIdsRequest.Builder> describeSenderIdsRequest) Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.default DescribeSenderIdsIterable
describeSenderIdsPaginator
(DescribeSenderIdsRequest describeSenderIdsRequest) Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.default DescribeSpendLimitsResponse
describeSpendLimits
(Consumer<DescribeSpendLimitsRequest.Builder> describeSpendLimitsRequest) Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.default DescribeSpendLimitsResponse
describeSpendLimits
(DescribeSpendLimitsRequest describeSpendLimitsRequest) Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.default DescribeSpendLimitsIterable
describeSpendLimitsPaginator
(Consumer<DescribeSpendLimitsRequest.Builder> describeSpendLimitsRequest) Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.default DescribeSpendLimitsIterable
describeSpendLimitsPaginator
(DescribeSpendLimitsRequest describeSpendLimitsRequest) Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.disassociateOriginationIdentity
(Consumer<DisassociateOriginationIdentityRequest.Builder> disassociateOriginationIdentityRequest) Removes the specified origination identity from an existing pool.disassociateOriginationIdentity
(DisassociateOriginationIdentityRequest disassociateOriginationIdentityRequest) Removes the specified origination identity from an existing pool.listPoolOriginationIdentities
(Consumer<ListPoolOriginationIdentitiesRequest.Builder> listPoolOriginationIdentitiesRequest) Lists all associated origination identities in your pool.listPoolOriginationIdentities
(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest) Lists all associated origination identities in your pool.listPoolOriginationIdentitiesPaginator
(Consumer<ListPoolOriginationIdentitiesRequest.Builder> listPoolOriginationIdentitiesRequest) Lists all associated origination identities in your pool.listPoolOriginationIdentitiesPaginator
(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest) Lists all associated origination identities in your pool.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags associated with a resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List all tags associated with a resource.default PutKeywordResponse
putKeyword
(Consumer<PutKeywordRequest.Builder> putKeywordRequest) Creates or updates a keyword configuration on an origination phone number or pool.default PutKeywordResponse
putKeyword
(PutKeywordRequest putKeywordRequest) Creates or updates a keyword configuration on an origination phone number or pool.default PutOptedOutNumberResponse
putOptedOutNumber
(Consumer<PutOptedOutNumberRequest.Builder> putOptedOutNumberRequest) Creates an opted out destination phone number in the opt-out list.default PutOptedOutNumberResponse
putOptedOutNumber
(PutOptedOutNumberRequest putOptedOutNumberRequest) Creates an opted out destination phone number in the opt-out list.default ReleasePhoneNumberResponse
releasePhoneNumber
(Consumer<ReleasePhoneNumberRequest.Builder> releasePhoneNumberRequest) Releases an existing origination phone number in your account.default ReleasePhoneNumberResponse
releasePhoneNumber
(ReleasePhoneNumberRequest releasePhoneNumberRequest) Releases an existing origination phone number in your account.default RequestPhoneNumberResponse
requestPhoneNumber
(Consumer<RequestPhoneNumberRequest.Builder> requestPhoneNumberRequest) Request an origination phone number for use in your account.default RequestPhoneNumberResponse
requestPhoneNumber
(RequestPhoneNumberRequest requestPhoneNumberRequest) Request an origination phone number for use in your account.default SendTextMessageResponse
sendTextMessage
(Consumer<SendTextMessageRequest.Builder> sendTextMessageRequest) Creates a new text message and sends it to a recipient's phone number.default SendTextMessageResponse
sendTextMessage
(SendTextMessageRequest sendTextMessageRequest) Creates a new text message and sends it to a recipient's phone number.default SendVoiceMessageResponse
sendVoiceMessage
(Consumer<SendVoiceMessageRequest.Builder> sendVoiceMessageRequest) Allows you to send a request that sends a text message through Amazon Pinpoint.default SendVoiceMessageResponse
sendVoiceMessage
(SendVoiceMessageRequest sendVoiceMessageRequest) Allows you to send a request that sends a text message through Amazon Pinpoint.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SetDefaultMessageTypeResponse
setDefaultMessageType
(Consumer<SetDefaultMessageTypeRequest.Builder> setDefaultMessageTypeRequest) Sets the default message type on a configuration set.default SetDefaultMessageTypeResponse
setDefaultMessageType
(SetDefaultMessageTypeRequest setDefaultMessageTypeRequest) Sets the default message type on a configuration set.default SetDefaultSenderIdResponse
setDefaultSenderId
(Consumer<SetDefaultSenderIdRequest.Builder> setDefaultSenderIdRequest) Sets default sender ID on a configuration set.default SetDefaultSenderIdResponse
setDefaultSenderId
(SetDefaultSenderIdRequest setDefaultSenderIdRequest) Sets default sender ID on a configuration set.setTextMessageSpendLimitOverride
(Consumer<SetTextMessageSpendLimitOverrideRequest.Builder> setTextMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending text messages.setTextMessageSpendLimitOverride
(SetTextMessageSpendLimitOverrideRequest setTextMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending text messages.setVoiceMessageSpendLimitOverride
(Consumer<SetVoiceMessageSpendLimitOverrideRequest.Builder> setVoiceMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending voice messages.setVoiceMessageSpendLimitOverride
(SetVoiceMessageSpendLimitOverrideRequest setVoiceMessageSpendLimitOverrideRequest) Sets an account level monthly spend limit override for sending voice messages.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource.default UpdateEventDestinationResponse
updateEventDestination
(Consumer<UpdateEventDestinationRequest.Builder> updateEventDestinationRequest) Updates an existing event destination in a configuration set.default UpdateEventDestinationResponse
updateEventDestination
(UpdateEventDestinationRequest updateEventDestinationRequest) Updates an existing event destination in a configuration set.default UpdatePhoneNumberResponse
updatePhoneNumber
(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) Updates the configuration of an existing origination phone number.default UpdatePhoneNumberResponse
updatePhoneNumber
(UpdatePhoneNumberRequest updatePhoneNumberRequest) Updates the configuration of an existing origination phone number.default UpdatePoolResponse
updatePool
(Consumer<UpdatePoolRequest.Builder> updatePoolRequest) Updates the configuration of an existing pool.default UpdatePoolResponse
updatePool
(UpdatePoolRequest updatePoolRequest) Updates the configuration of an existing pool.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateOriginationIdentity
default AssociateOriginationIdentityResponse associateOriginationIdentity(AssociateOriginationIdentityRequest associateOriginationIdentityRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an Error is returned.
- Parameters:
associateOriginationIdentityRequest
-- Returns:
- Result of the AssociateOriginationIdentity operation returned by the service.
- See Also:
-
associateOriginationIdentity
default AssociateOriginationIdentityResponse associateOriginationIdentity(Consumer<AssociateOriginationIdentityRequest.Builder> associateOriginationIdentityRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an Error is returned.
This is a convenience which creates an instance of the
AssociateOriginationIdentityRequest.Builder
avoiding the need to create one manually viaAssociateOriginationIdentityRequest.builder()
- Parameters:
associateOriginationIdentityRequest
- AConsumer
that will call methods onAssociateOriginationIdentityRequest.Builder
to create a request.- Returns:
- Result of the AssociateOriginationIdentity operation returned by the service.
- See Also:
-
createConfigurationSet
default CreateConfigurationSetResponse createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
- Parameters:
createConfigurationSetRequest
-- Returns:
- Result of the CreateConfigurationSet operation returned by the service.
- See Also:
-
createConfigurationSet
default CreateConfigurationSetResponse createConfigurationSet(Consumer<CreateConfigurationSetRequest.Builder> createConfigurationSetRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
This is a convenience which creates an instance of the
CreateConfigurationSetRequest.Builder
avoiding the need to create one manually viaCreateConfigurationSetRequest.builder()
- Parameters:
createConfigurationSetRequest
- AConsumer
that will call methods onCreateConfigurationSetRequest.Builder
to create a request.- Returns:
- Result of the CreateConfigurationSet operation returned by the service.
- See Also:
-
createEventDestination
default CreateEventDestinationResponse createEventDestination(CreateEventDestinationRequest createEventDestinationRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
- Parameters:
createEventDestinationRequest
-- Returns:
- Result of the CreateEventDestination operation returned by the service.
- See Also:
-
createEventDestination
default CreateEventDestinationResponse createEventDestination(Consumer<CreateEventDestinationRequest.Builder> createEventDestinationRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
This is a convenience which creates an instance of the
CreateEventDestinationRequest.Builder
avoiding the need to create one manually viaCreateEventDestinationRequest.builder()
- Parameters:
createEventDestinationRequest
- AConsumer
that will call methods onCreateEventDestinationRequest.Builder
to create a request.- Returns:
- Result of the CreateEventDestination operation returned by the service.
- See Also:
-
createOptOutList
default CreateOptOutListResponse createOptOutList(CreateOptOutListRequest createOptOutListRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new opt-out list.
If the opt-out list name already exists, an Error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
- Parameters:
createOptOutListRequest
-- Returns:
- Result of the CreateOptOutList operation returned by the service.
- See Also:
-
createOptOutList
default CreateOptOutListResponse createOptOutList(Consumer<CreateOptOutListRequest.Builder> createOptOutListRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new opt-out list.
If the opt-out list name already exists, an Error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.
This is a convenience which creates an instance of the
CreateOptOutListRequest.Builder
avoiding the need to create one manually viaCreateOptOutListRequest.builder()
- Parameters:
createOptOutListRequest
- AConsumer
that will call methods onCreateOptOutListRequest.Builder
to create a request.- Returns:
- Result of the CreateOptOutList operation returned by the service.
- See Also:
-
createPool
default CreatePoolResponse createPool(CreatePoolRequest createPoolRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
- Parameters:
createPoolRequest
-- Returns:
- Result of the CreatePool operation returned by the service.
- See Also:
-
createPool
default CreatePoolResponse createPool(Consumer<CreatePoolRequest.Builder> createPoolRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
This is a convenience which creates an instance of the
CreatePoolRequest.Builder
avoiding the need to create one manually viaCreatePoolRequest.builder()
- Parameters:
createPoolRequest
- AConsumer
that will call methods onCreatePoolRequest.Builder
to create a request.- Returns:
- Result of the CreatePool operation returned by the service.
- See Also:
-
deleteConfigurationSet
default DeleteConfigurationSetResponse deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
- Parameters:
deleteConfigurationSetRequest
-- Returns:
- Result of the DeleteConfigurationSet operation returned by the service.
- See Also:
-
deleteConfigurationSet
default DeleteConfigurationSetResponse deleteConfigurationSet(Consumer<DeleteConfigurationSetRequest.Builder> deleteConfigurationSetRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
This is a convenience which creates an instance of the
DeleteConfigurationSetRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationSetRequest.builder()
- Parameters:
deleteConfigurationSetRequest
- AConsumer
that will call methods onDeleteConfigurationSetRequest.Builder
to create a request.- Returns:
- Result of the DeleteConfigurationSet operation returned by the service.
- See Also:
-
deleteDefaultMessageType
default DeleteDefaultMessageTypeResponse deleteDefaultMessageType(DeleteDefaultMessageTypeRequest deleteDefaultMessageTypeRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
- Parameters:
deleteDefaultMessageTypeRequest
-- Returns:
- Result of the DeleteDefaultMessageType operation returned by the service.
- See Also:
-
deleteDefaultMessageType
default DeleteDefaultMessageTypeResponse deleteDefaultMessageType(Consumer<DeleteDefaultMessageTypeRequest.Builder> deleteDefaultMessageTypeRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
This is a convenience which creates an instance of the
DeleteDefaultMessageTypeRequest.Builder
avoiding the need to create one manually viaDeleteDefaultMessageTypeRequest.builder()
- Parameters:
deleteDefaultMessageTypeRequest
- AConsumer
that will call methods onDeleteDefaultMessageTypeRequest.Builder
to create a request.- Returns:
- Result of the DeleteDefaultMessageType operation returned by the service.
- See Also:
-
deleteDefaultSenderId
default DeleteDefaultSenderIdResponse deleteDefaultSenderId(DeleteDefaultSenderIdRequest deleteDefaultSenderIdRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
- Parameters:
deleteDefaultSenderIdRequest
-- Returns:
- Result of the DeleteDefaultSenderId operation returned by the service.
- See Also:
-
deleteDefaultSenderId
default DeleteDefaultSenderIdResponse deleteDefaultSenderId(Consumer<DeleteDefaultSenderIdRequest.Builder> deleteDefaultSenderIdRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
This is a convenience which creates an instance of the
DeleteDefaultSenderIdRequest.Builder
avoiding the need to create one manually viaDeleteDefaultSenderIdRequest.builder()
- Parameters:
deleteDefaultSenderIdRequest
- AConsumer
that will call methods onDeleteDefaultSenderIdRequest.Builder
to create a request.- Returns:
- Result of the DeleteDefaultSenderId operation returned by the service.
- See Also:
-
deleteEventDestination
default DeleteEventDestinationResponse deleteEventDestination(DeleteEventDestinationRequest deleteEventDestinationRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
- Parameters:
deleteEventDestinationRequest
-- Returns:
- Result of the DeleteEventDestination operation returned by the service.
- See Also:
-
deleteEventDestination
default DeleteEventDestinationResponse deleteEventDestination(Consumer<DeleteEventDestinationRequest.Builder> deleteEventDestinationRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
This is a convenience which creates an instance of the
DeleteEventDestinationRequest.Builder
avoiding the need to create one manually viaDeleteEventDestinationRequest.builder()
- Parameters:
deleteEventDestinationRequest
- AConsumer
that will call methods onDeleteEventDestinationRequest.Builder
to create a request.- Returns:
- Result of the DeleteEventDestination operation returned by the service.
- See Also:
-
deleteKeyword
default DeleteKeywordResponse deleteKeyword(DeleteKeywordRequest deleteKeywordRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords "HELP" and "STOP" can't be deleted or modified.
- Parameters:
deleteKeywordRequest
-- Returns:
- Result of the DeleteKeyword operation returned by the service.
- See Also:
-
deleteKeyword
default DeleteKeywordResponse deleteKeyword(Consumer<DeleteKeywordRequest.Builder> deleteKeywordRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
Keywords "HELP" and "STOP" can't be deleted or modified.
This is a convenience which creates an instance of the
DeleteKeywordRequest.Builder
avoiding the need to create one manually viaDeleteKeywordRequest.builder()
- Parameters:
deleteKeywordRequest
- AConsumer
that will call methods onDeleteKeywordRequest.Builder
to create a request.- Returns:
- Result of the DeleteKeyword operation returned by the service.
- See Also:
-
deleteOptOutList
default DeleteOptOutListResponse deleteOptOutList(DeleteOptOutListRequest deleteOptOutListRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an Error is returned.
- Parameters:
deleteOptOutListRequest
-- Returns:
- Result of the DeleteOptOutList operation returned by the service.
- See Also:
-
deleteOptOutList
default DeleteOptOutListResponse deleteOptOutList(Consumer<DeleteOptOutListRequest.Builder> deleteOptOutListRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an Error is returned.
This is a convenience which creates an instance of the
DeleteOptOutListRequest.Builder
avoiding the need to create one manually viaDeleteOptOutListRequest.builder()
- Parameters:
deleteOptOutListRequest
- AConsumer
that will call methods onDeleteOptOutListRequest.Builder
to create a request.- Returns:
- Result of the DeleteOptOutList operation returned by the service.
- See Also:
-
deleteOptedOutNumber
default DeleteOptedOutNumberResponse deleteOptedOutNumber(DeleteOptedOutNumberRequest deleteOptedOutNumberRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an Error is returned.
- Parameters:
deleteOptedOutNumberRequest
-- Returns:
- Result of the DeleteOptedOutNumber operation returned by the service.
- See Also:
-
deleteOptedOutNumber
default DeleteOptedOutNumberResponse deleteOptedOutNumber(Consumer<DeleteOptedOutNumberRequest.Builder> deleteOptedOutNumberRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an Error is returned.
This is a convenience which creates an instance of the
DeleteOptedOutNumberRequest.Builder
avoiding the need to create one manually viaDeleteOptedOutNumberRequest.builder()
- Parameters:
deleteOptedOutNumberRequest
- AConsumer
that will call methods onDeleteOptedOutNumberRequest.Builder
to create a request.- Returns:
- Result of the DeleteOptedOutNumber operation returned by the service.
- See Also:
-
deletePool
default DeletePoolResponse deletePool(DeletePoolRequest deletePoolRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
- Parameters:
deletePoolRequest
-- Returns:
- Result of the DeletePool operation returned by the service.
- See Also:
-
deletePool
default DeletePoolResponse deletePool(Consumer<DeletePoolRequest.Builder> deletePoolRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
This is a convenience which creates an instance of the
DeletePoolRequest.Builder
avoiding the need to create one manually viaDeletePoolRequest.builder()
- Parameters:
deletePoolRequest
- AConsumer
that will call methods onDeletePoolRequest.Builder
to create a request.- Returns:
- Result of the DeletePool operation returned by the service.
- See Also:
-
deleteTextMessageSpendLimitOverride
default DeleteTextMessageSpendLimitOverrideResponse deleteTextMessageSpendLimitOverride(DeleteTextMessageSpendLimitOverrideRequest deleteTextMessageSpendLimitOverrideRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the
EnforcedLimit
to equal theMaxLimit
, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.- Parameters:
deleteTextMessageSpendLimitOverrideRequest
-- Returns:
- Result of the DeleteTextMessageSpendLimitOverride operation returned by the service.
- See Also:
-
deleteTextMessageSpendLimitOverride
default DeleteTextMessageSpendLimitOverrideResponse deleteTextMessageSpendLimitOverride(Consumer<DeleteTextMessageSpendLimitOverrideRequest.Builder> deleteTextMessageSpendLimitOverrideRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the
EnforcedLimit
to equal theMaxLimit
, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
This is a convenience which creates an instance of the
DeleteTextMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaDeleteTextMessageSpendLimitOverrideRequest.builder()
- Parameters:
deleteTextMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onDeleteTextMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- Result of the DeleteTextMessageSpendLimitOverride operation returned by the service.
- See Also:
-
deleteVoiceMessageSpendLimitOverride
default DeleteVoiceMessageSpendLimitOverrideResponse deleteVoiceMessageSpendLimitOverride(DeleteVoiceMessageSpendLimitOverrideRequest deleteVoiceMessageSpendLimitOverrideRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the
EnforcedLimit
equal to theMaxLimit
, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.- Parameters:
deleteVoiceMessageSpendLimitOverrideRequest
-- Returns:
- Result of the DeleteVoiceMessageSpendLimitOverride operation returned by the service.
- See Also:
-
deleteVoiceMessageSpendLimitOverride
default DeleteVoiceMessageSpendLimitOverrideResponse deleteVoiceMessageSpendLimitOverride(Consumer<DeleteVoiceMessageSpendLimitOverrideRequest.Builder> deleteVoiceMessageSpendLimitOverrideRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the
EnforcedLimit
equal to theMaxLimit
, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
This is a convenience which creates an instance of the
DeleteVoiceMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaDeleteVoiceMessageSpendLimitOverrideRequest.builder()
- Parameters:
deleteVoiceMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onDeleteVoiceMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- Result of the DeleteVoiceMessageSpendLimitOverride operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
- Parameters:
describeAccountAttributesRequest
-- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
This is a convenience which creates an instance of the
DescribeAccountAttributesRequest.Builder
avoiding the need to create one manually viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributesPaginator
default DescribeAccountAttributesIterable describeAccountAttributesPaginator(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
This is a variant of
describeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesIterable responses = client.describeAccountAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesIterable responses = client .describeAccountAttributesPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesIterable responses = client.describeAccountAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
operation.- Parameters:
describeAccountAttributesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAccountAttributesPaginator
default DescribeAccountAttributesIterable describeAccountAttributesPaginator(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
This is a variant of
describeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesIterable responses = client.describeAccountAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesIterable responses = client .describeAccountAttributesPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountAttributesIterable responses = client.describeAccountAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeAccountAttributes(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountAttributesRequest)
operation.This is a convenience which creates an instance of the
DescribeAccountAttributesRequest.Builder
avoiding the need to create one manually viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
- Parameters:
describeAccountLimitsRequest
-- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builder
avoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()
- Parameters:
describeAccountLimitsRequest
- AConsumer
that will call methods onDescribeAccountLimitsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsIterable describeAccountLimitsPaginator(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
This is a variant of
describeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsIterable responses = client .describeAccountLimitsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
operation.- Parameters:
describeAccountLimitsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsIterable describeAccountLimitsPaginator(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
This is a variant of
describeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsIterable responses = client .describeAccountLimitsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeAccountLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeAccountLimitsRequest)
operation.This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builder
avoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()
- Parameters:
describeAccountLimitsRequest
- AConsumer
that will call methods onDescribeAccountLimitsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeConfigurationSets
default DescribeConfigurationSetsResponse describeConfigurationSets(DescribeConfigurationSetsRequest describeConfigurationSetsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
- Parameters:
describeConfigurationSetsRequest
-- Returns:
- Result of the DescribeConfigurationSets operation returned by the service.
- See Also:
-
describeConfigurationSets
default DescribeConfigurationSetsResponse describeConfigurationSets(Consumer<DescribeConfigurationSetsRequest.Builder> describeConfigurationSetsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
This is a convenience which creates an instance of the
DescribeConfigurationSetsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationSetsRequest.builder()
- Parameters:
describeConfigurationSetsRequest
- AConsumer
that will call methods onDescribeConfigurationSetsRequest.Builder
to create a request.- Returns:
- Result of the DescribeConfigurationSets operation returned by the service.
- See Also:
-
describeConfigurationSetsPaginator
default DescribeConfigurationSetsIterable describeConfigurationSetsPaginator(DescribeConfigurationSetsRequest describeConfigurationSetsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
This is a variant of
describeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsIterable responses = client.describeConfigurationSetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsIterable responses = client .describeConfigurationSetsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsIterable responses = client.describeConfigurationSetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
operation.- Parameters:
describeConfigurationSetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeConfigurationSetsPaginator
default DescribeConfigurationSetsIterable describeConfigurationSetsPaginator(Consumer<DescribeConfigurationSetsRequest.Builder> describeConfigurationSetsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
This is a variant of
describeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsIterable responses = client.describeConfigurationSetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsIterable responses = client .describeConfigurationSetsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeConfigurationSetsIterable responses = client.describeConfigurationSetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeConfigurationSets(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeConfigurationSetsRequest)
operation.This is a convenience which creates an instance of the
DescribeConfigurationSetsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationSetsRequest.builder()
- Parameters:
describeConfigurationSetsRequest
- AConsumer
that will call methods onDescribeConfigurationSetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeKeywords
default DescribeKeywordsResponse describeKeywords(DescribeKeywordsRequest describeKeywordsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
- Parameters:
describeKeywordsRequest
-- Returns:
- Result of the DescribeKeywords operation returned by the service.
- See Also:
-
describeKeywords
default DescribeKeywordsResponse describeKeywords(Consumer<DescribeKeywordsRequest.Builder> describeKeywordsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
This is a convenience which creates an instance of the
DescribeKeywordsRequest.Builder
avoiding the need to create one manually viaDescribeKeywordsRequest.builder()
- Parameters:
describeKeywordsRequest
- AConsumer
that will call methods onDescribeKeywordsRequest.Builder
to create a request.- Returns:
- Result of the DescribeKeywords operation returned by the service.
- See Also:
-
describeKeywordsPaginator
default DescribeKeywordsIterable describeKeywordsPaginator(DescribeKeywordsRequest describeKeywordsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
This is a variant of
describeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsIterable responses = client.describeKeywordsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsIterable responses = client .describeKeywordsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsIterable responses = client.describeKeywordsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
operation.- Parameters:
describeKeywordsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeKeywordsPaginator
default DescribeKeywordsIterable describeKeywordsPaginator(Consumer<DescribeKeywordsRequest.Builder> describeKeywordsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
This is a variant of
describeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsIterable responses = client.describeKeywordsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsIterable responses = client .describeKeywordsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeKeywordsIterable responses = client.describeKeywordsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeKeywords(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeKeywordsRequest)
operation.This is a convenience which creates an instance of the
DescribeKeywordsRequest.Builder
avoiding the need to create one manually viaDescribeKeywordsRequest.builder()
- Parameters:
describeKeywordsRequest
- AConsumer
that will call methods onDescribeKeywordsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptOutLists
default DescribeOptOutListsResponse describeOptOutLists(DescribeOptOutListsRequest describeOptOutListsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an Error is returned.
- Parameters:
describeOptOutListsRequest
-- Returns:
- Result of the DescribeOptOutLists operation returned by the service.
- See Also:
-
describeOptOutLists
default DescribeOptOutListsResponse describeOptOutLists(Consumer<DescribeOptOutListsRequest.Builder> describeOptOutListsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an Error is returned.
This is a convenience which creates an instance of the
DescribeOptOutListsRequest.Builder
avoiding the need to create one manually viaDescribeOptOutListsRequest.builder()
- Parameters:
describeOptOutListsRequest
- AConsumer
that will call methods onDescribeOptOutListsRequest.Builder
to create a request.- Returns:
- Result of the DescribeOptOutLists operation returned by the service.
- See Also:
-
describeOptOutListsPaginator
default DescribeOptOutListsIterable describeOptOutListsPaginator(DescribeOptOutListsRequest describeOptOutListsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an Error is returned.
This is a variant of
describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client.describeOptOutListsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client .describeOptOutListsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client.describeOptOutListsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation.- Parameters:
describeOptOutListsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptOutListsPaginator
default DescribeOptOutListsIterable describeOptOutListsPaginator(Consumer<DescribeOptOutListsRequest.Builder> describeOptOutListsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an Error is returned.
This is a variant of
describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client.describeOptOutListsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client .describeOptOutListsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client.describeOptOutListsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation.This is a convenience which creates an instance of the
DescribeOptOutListsRequest.Builder
avoiding the need to create one manually viaDescribeOptOutListsRequest.builder()
- Parameters:
describeOptOutListsRequest
- AConsumer
that will call methods onDescribeOptOutListsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptedOutNumbers
default DescribeOptedOutNumbersResponse describeOptedOutNumbers(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an Error is returned.
- Parameters:
describeOptedOutNumbersRequest
-- Returns:
- Result of the DescribeOptedOutNumbers operation returned by the service.
- See Also:
-
describeOptedOutNumbers
default DescribeOptedOutNumbersResponse describeOptedOutNumbers(Consumer<DescribeOptedOutNumbersRequest.Builder> describeOptedOutNumbersRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an Error is returned.
This is a convenience which creates an instance of the
DescribeOptedOutNumbersRequest.Builder
avoiding the need to create one manually viaDescribeOptedOutNumbersRequest.builder()
- Parameters:
describeOptedOutNumbersRequest
- AConsumer
that will call methods onDescribeOptedOutNumbersRequest.Builder
to create a request.- Returns:
- Result of the DescribeOptedOutNumbers operation returned by the service.
- See Also:
-
describeOptedOutNumbersPaginator
default DescribeOptedOutNumbersIterable describeOptedOutNumbersPaginator(DescribeOptedOutNumbersRequest describeOptedOutNumbersRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an Error is returned.
This is a variant of
describeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersIterable responses = client.describeOptedOutNumbersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersIterable responses = client .describeOptedOutNumbersPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersIterable responses = client.describeOptedOutNumbersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
operation.- Parameters:
describeOptedOutNumbersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOptedOutNumbersPaginator
default DescribeOptedOutNumbersIterable describeOptedOutNumbersPaginator(Consumer<DescribeOptedOutNumbersRequest.Builder> describeOptedOutNumbersRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an Error is returned.
This is a variant of
describeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersIterable responses = client.describeOptedOutNumbersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersIterable responses = client .describeOptedOutNumbersPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptedOutNumbersIterable responses = client.describeOptedOutNumbersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeOptedOutNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest)
operation.This is a convenience which creates an instance of the
DescribeOptedOutNumbersRequest.Builder
avoiding the need to create one manually viaDescribeOptedOutNumbersRequest.builder()
- Parameters:
describeOptedOutNumbersRequest
- AConsumer
that will call methods onDescribeOptedOutNumbersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePhoneNumbers
default DescribePhoneNumbersResponse describePhoneNumbers(DescribePhoneNumbersRequest describePhoneNumbersRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an Error is returned.
- Parameters:
describePhoneNumbersRequest
-- Returns:
- Result of the DescribePhoneNumbers operation returned by the service.
- See Also:
-
describePhoneNumbers
default DescribePhoneNumbersResponse describePhoneNumbers(Consumer<DescribePhoneNumbersRequest.Builder> describePhoneNumbersRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an Error is returned.
This is a convenience which creates an instance of the
DescribePhoneNumbersRequest.Builder
avoiding the need to create one manually viaDescribePhoneNumbersRequest.builder()
- Parameters:
describePhoneNumbersRequest
- AConsumer
that will call methods onDescribePhoneNumbersRequest.Builder
to create a request.- Returns:
- Result of the DescribePhoneNumbers operation returned by the service.
- See Also:
-
describePhoneNumbersPaginator
default DescribePhoneNumbersIterable describePhoneNumbersPaginator(DescribePhoneNumbersRequest describePhoneNumbersRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an Error is returned.
This is a variant of
describePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersIterable responses = client.describePhoneNumbersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersIterable responses = client .describePhoneNumbersPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersIterable responses = client.describePhoneNumbersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
operation.- Parameters:
describePhoneNumbersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePhoneNumbersPaginator
default DescribePhoneNumbersIterable describePhoneNumbersPaginator(Consumer<DescribePhoneNumbersRequest.Builder> describePhoneNumbersRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an Error is returned.
This is a variant of
describePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersIterable responses = client.describePhoneNumbersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersIterable responses = client .describePhoneNumbersPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePhoneNumbersIterable responses = client.describePhoneNumbersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describePhoneNumbers(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest)
operation.This is a convenience which creates an instance of the
DescribePhoneNumbersRequest.Builder
avoiding the need to create one manually viaDescribePhoneNumbersRequest.builder()
- Parameters:
describePhoneNumbersRequest
- AConsumer
that will call methods onDescribePhoneNumbersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePools
default DescribePoolsResponse describePools(DescribePoolsRequest describePoolsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
- Parameters:
describePoolsRequest
-- Returns:
- Result of the DescribePools operation returned by the service.
- See Also:
-
describePools
default DescribePoolsResponse describePools(Consumer<DescribePoolsRequest.Builder> describePoolsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
This is a convenience which creates an instance of the
DescribePoolsRequest.Builder
avoiding the need to create one manually viaDescribePoolsRequest.builder()
- Parameters:
describePoolsRequest
- AConsumer
that will call methods onDescribePoolsRequest.Builder
to create a request.- Returns:
- Result of the DescribePools operation returned by the service.
- See Also:
-
describePoolsPaginator
default DescribePoolsIterable describePoolsPaginator(DescribePoolsRequest describePoolsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
This is a variant of
describePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsIterable responses = client.describePoolsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsIterable responses = client .describePoolsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsIterable responses = client.describePoolsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
operation.- Parameters:
describePoolsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePoolsPaginator
default DescribePoolsIterable describePoolsPaginator(Consumer<DescribePoolsRequest.Builder> describePoolsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an Error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
This is a variant of
describePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsIterable responses = client.describePoolsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsIterable responses = client .describePoolsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribePoolsIterable responses = client.describePoolsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describePools(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest)
operation.This is a convenience which creates an instance of the
DescribePoolsRequest.Builder
avoiding the need to create one manually viaDescribePoolsRequest.builder()
- Parameters:
describePoolsRequest
- AConsumer
that will call methods onDescribePoolsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSenderIds
default DescribeSenderIdsResponse describeSenderIds(DescribeSenderIdsRequest describeSenderIdsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an Error is returned.
- Parameters:
describeSenderIdsRequest
-- Returns:
- Result of the DescribeSenderIds operation returned by the service.
- See Also:
-
describeSenderIds
default DescribeSenderIdsResponse describeSenderIds(Consumer<DescribeSenderIdsRequest.Builder> describeSenderIdsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an Error is returned.
This is a convenience which creates an instance of the
DescribeSenderIdsRequest.Builder
avoiding the need to create one manually viaDescribeSenderIdsRequest.builder()
- Parameters:
describeSenderIdsRequest
- AConsumer
that will call methods onDescribeSenderIdsRequest.Builder
to create a request.- Returns:
- Result of the DescribeSenderIds operation returned by the service.
- See Also:
-
describeSenderIdsPaginator
default DescribeSenderIdsIterable describeSenderIdsPaginator(DescribeSenderIdsRequest describeSenderIdsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an Error is returned.
This is a variant of
describeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsIterable responses = client.describeSenderIdsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsIterable responses = client .describeSenderIdsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsIterable responses = client.describeSenderIdsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
operation.- Parameters:
describeSenderIdsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSenderIdsPaginator
default DescribeSenderIdsIterable describeSenderIdsPaginator(Consumer<DescribeSenderIdsRequest.Builder> describeSenderIdsRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an Error is returned.
This is a variant of
describeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsIterable responses = client.describeSenderIdsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsIterable responses = client .describeSenderIdsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSenderIdsIterable responses = client.describeSenderIdsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeSenderIds(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSenderIdsRequest)
operation.This is a convenience which creates an instance of the
DescribeSenderIdsRequest.Builder
avoiding the need to create one manually viaDescribeSenderIdsRequest.builder()
- Parameters:
describeSenderIdsRequest
- AConsumer
that will call methods onDescribeSenderIdsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSpendLimits
default DescribeSpendLimitsResponse describeSpendLimits(DescribeSpendLimitsRequest describeSpendLimitsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
- Parameters:
describeSpendLimitsRequest
-- Returns:
- Result of the DescribeSpendLimits operation returned by the service.
- See Also:
-
describeSpendLimits
default DescribeSpendLimitsResponse describeSpendLimits(Consumer<DescribeSpendLimitsRequest.Builder> describeSpendLimitsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
This is a convenience which creates an instance of the
DescribeSpendLimitsRequest.Builder
avoiding the need to create one manually viaDescribeSpendLimitsRequest.builder()
- Parameters:
describeSpendLimitsRequest
- AConsumer
that will call methods onDescribeSpendLimitsRequest.Builder
to create a request.- Returns:
- Result of the DescribeSpendLimits operation returned by the service.
- See Also:
-
describeSpendLimitsPaginator
default DescribeSpendLimitsIterable describeSpendLimitsPaginator(DescribeSpendLimitsRequest describeSpendLimitsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
This is a variant of
describeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsIterable responses = client.describeSpendLimitsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsIterable responses = client .describeSpendLimitsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsIterable responses = client.describeSpendLimitsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
operation.- Parameters:
describeSpendLimitsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSpendLimitsPaginator
default DescribeSpendLimitsIterable describeSpendLimitsPaginator(Consumer<DescribeSpendLimitsRequest.Builder> describeSpendLimitsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.
This is a variant of
describeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsIterable responses = client.describeSpendLimitsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsIterable responses = client .describeSpendLimitsPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeSpendLimitsIterable responses = client.describeSpendLimitsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeSpendLimits(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeSpendLimitsRequest)
operation.This is a convenience which creates an instance of the
DescribeSpendLimitsRequest.Builder
avoiding the need to create one manually viaDescribeSpendLimitsRequest.builder()
- Parameters:
describeSpendLimitsRequest
- AConsumer
that will call methods onDescribeSpendLimitsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
disassociateOriginationIdentity
default DisassociateOriginationIdentityResponse disassociateOriginationIdentity(DisassociateOriginationIdentityRequest disassociateOriginationIdentityRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an Error is returned.
- Parameters:
disassociateOriginationIdentityRequest
-- Returns:
- Result of the DisassociateOriginationIdentity operation returned by the service.
- See Also:
-
disassociateOriginationIdentity
default DisassociateOriginationIdentityResponse disassociateOriginationIdentity(Consumer<DisassociateOriginationIdentityRequest.Builder> disassociateOriginationIdentityRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an Error is returned.
This is a convenience which creates an instance of the
DisassociateOriginationIdentityRequest.Builder
avoiding the need to create one manually viaDisassociateOriginationIdentityRequest.builder()
- Parameters:
disassociateOriginationIdentityRequest
- AConsumer
that will call methods onDisassociateOriginationIdentityRequest.Builder
to create a request.- Returns:
- Result of the DisassociateOriginationIdentity operation returned by the service.
- See Also:
-
listPoolOriginationIdentities
default ListPoolOriginationIdentitiesResponse listPoolOriginationIdentities(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
- Parameters:
listPoolOriginationIdentitiesRequest
-- Returns:
- Result of the ListPoolOriginationIdentities operation returned by the service.
- See Also:
-
listPoolOriginationIdentities
default ListPoolOriginationIdentitiesResponse listPoolOriginationIdentities(Consumer<ListPoolOriginationIdentitiesRequest.Builder> listPoolOriginationIdentitiesRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
This is a convenience which creates an instance of the
ListPoolOriginationIdentitiesRequest.Builder
avoiding the need to create one manually viaListPoolOriginationIdentitiesRequest.builder()
- Parameters:
listPoolOriginationIdentitiesRequest
- AConsumer
that will call methods onListPoolOriginationIdentitiesRequest.Builder
to create a request.- Returns:
- Result of the ListPoolOriginationIdentities operation returned by the service.
- See Also:
-
listPoolOriginationIdentitiesPaginator
default ListPoolOriginationIdentitiesIterable listPoolOriginationIdentitiesPaginator(ListPoolOriginationIdentitiesRequest listPoolOriginationIdentitiesRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
This is a variant of
listPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesIterable responses = client.listPoolOriginationIdentitiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesIterable responses = client .listPoolOriginationIdentitiesPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesIterable responses = client.listPoolOriginationIdentitiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
listPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
operation.- Parameters:
listPoolOriginationIdentitiesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPoolOriginationIdentitiesPaginator
default ListPoolOriginationIdentitiesIterable listPoolOriginationIdentitiesPaginator(Consumer<ListPoolOriginationIdentitiesRequest.Builder> listPoolOriginationIdentitiesRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
This is a variant of
listPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
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 Streamsoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesIterable responses = client.listPoolOriginationIdentitiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesIterable responses = client .listPoolOriginationIdentitiesPaginator(request); for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.pinpointsmsvoicev2.paginators.ListPoolOriginationIdentitiesIterable responses = client.listPoolOriginationIdentitiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
listPoolOriginationIdentities(software.amazon.awssdk.services.pinpointsmsvoicev2.model.ListPoolOriginationIdentitiesRequest)
operation.This is a convenience which creates an instance of the
ListPoolOriginationIdentitiesRequest.Builder
avoiding the need to create one manually viaListPoolOriginationIdentitiesRequest.builder()
- Parameters:
listPoolOriginationIdentitiesRequest
- AConsumer
that will call methods onListPoolOriginationIdentitiesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception List all tags associated with a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception List all tags associated with a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putKeyword
default PutKeywordResponse putKeyword(PutKeywordRequest putKeywordRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
- Parameters:
putKeywordRequest
-- Returns:
- Result of the PutKeyword operation returned by the service.
- See Also:
-
putKeyword
default PutKeywordResponse putKeyword(Consumer<PutKeywordRequest.Builder> putKeywordRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an Error is returned.
This is a convenience which creates an instance of the
PutKeywordRequest.Builder
avoiding the need to create one manually viaPutKeywordRequest.builder()
- Parameters:
putKeywordRequest
- AConsumer
that will call methods onPutKeywordRequest.Builder
to create a request.- Returns:
- Result of the PutKeyword operation returned by the service.
- See Also:
-
putOptedOutNumber
default PutOptedOutNumberResponse putOptedOutNumber(PutOptedOutNumberRequest putOptedOutNumberRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned.
- Parameters:
putOptedOutNumberRequest
-- Returns:
- Result of the PutOptedOutNumber operation returned by the service.
- See Also:
-
putOptedOutNumber
default PutOptedOutNumberResponse putOptedOutNumber(Consumer<PutOptedOutNumberRequest.Builder> putOptedOutNumberRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an Error is returned.
This is a convenience which creates an instance of the
PutOptedOutNumberRequest.Builder
avoiding the need to create one manually viaPutOptedOutNumberRequest.builder()
- Parameters:
putOptedOutNumberRequest
- AConsumer
that will call methods onPutOptedOutNumberRequest.Builder
to create a request.- Returns:
- Result of the PutOptedOutNumber operation returned by the service.
- See Also:
-
releasePhoneNumber
default ReleasePhoneNumberResponse releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned.
- Parameters:
releasePhoneNumberRequest
-- Returns:
- Result of the ReleasePhoneNumber operation returned by the service.
- See Also:
-
releasePhoneNumber
default ReleasePhoneNumberResponse releasePhoneNumber(Consumer<ReleasePhoneNumberRequest.Builder> releasePhoneNumberRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned.
This is a convenience which creates an instance of the
ReleasePhoneNumberRequest.Builder
avoiding the need to create one manually viaReleasePhoneNumberRequest.builder()
- Parameters:
releasePhoneNumberRequest
- AConsumer
that will call methods onReleasePhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the ReleasePhoneNumber operation returned by the service.
- See Also:
-
requestPhoneNumber
default RequestPhoneNumberResponse requestPhoneNumber(RequestPhoneNumberRequest requestPhoneNumberRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
- Parameters:
requestPhoneNumberRequest
-- Returns:
- Result of the RequestPhoneNumber operation returned by the service.
- See Also:
-
requestPhoneNumber
default RequestPhoneNumberResponse requestPhoneNumber(Consumer<RequestPhoneNumberRequest.Builder> requestPhoneNumberRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
This is a convenience which creates an instance of the
RequestPhoneNumberRequest.Builder
avoiding the need to create one manually viaRequestPhoneNumberRequest.builder()
- Parameters:
requestPhoneNumberRequest
- AConsumer
that will call methods onRequestPhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the RequestPhoneNumber operation returned by the service.
- See Also:
-
sendTextMessage
default SendTextMessageResponse sendTextMessage(SendTextMessageRequest sendTextMessageRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
- Parameters:
sendTextMessageRequest
-- Returns:
- Result of the SendTextMessage operation returned by the service.
- See Also:
-
sendTextMessage
default SendTextMessageResponse sendTextMessage(Consumer<SendTextMessageRequest.Builder> sendTextMessageRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.
This is a convenience which creates an instance of the
SendTextMessageRequest.Builder
avoiding the need to create one manually viaSendTextMessageRequest.builder()
- Parameters:
sendTextMessageRequest
- AConsumer
that will call methods onSendTextMessageRequest.Builder
to create a request.- Returns:
- Result of the SendTextMessage operation returned by the service.
- See Also:
-
sendVoiceMessage
default SendVoiceMessageResponse sendVoiceMessage(SendVoiceMessageRequest sendVoiceMessageRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
- Parameters:
sendVoiceMessageRequest
-- Returns:
- Result of the SendVoiceMessage operation returned by the service.
- See Also:
-
sendVoiceMessage
default SendVoiceMessageResponse sendVoiceMessage(Consumer<SendVoiceMessageRequest.Builder> sendVoiceMessageRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Allows you to send a request that sends a text message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
This is a convenience which creates an instance of the
SendVoiceMessageRequest.Builder
avoiding the need to create one manually viaSendVoiceMessageRequest.builder()
- Parameters:
sendVoiceMessageRequest
- AConsumer
that will call methods onSendVoiceMessageRequest.Builder
to create a request.- Returns:
- Result of the SendVoiceMessage operation returned by the service.
- See Also:
-
setDefaultMessageType
default SetDefaultMessageTypeResponse setDefaultMessageType(SetDefaultMessageTypeRequest setDefaultMessageTypeRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
- Parameters:
setDefaultMessageTypeRequest
-- Returns:
- Result of the SetDefaultMessageType operation returned by the service.
- See Also:
-
setDefaultMessageType
default SetDefaultMessageTypeResponse setDefaultMessageType(Consumer<SetDefaultMessageTypeRequest.Builder> setDefaultMessageTypeRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
This is a convenience which creates an instance of the
SetDefaultMessageTypeRequest.Builder
avoiding the need to create one manually viaSetDefaultMessageTypeRequest.builder()
- Parameters:
setDefaultMessageTypeRequest
- AConsumer
that will call methods onSetDefaultMessageTypeRequest.Builder
to create a request.- Returns:
- Result of the SetDefaultMessageType operation returned by the service.
- See Also:
-
setDefaultSenderId
default SetDefaultSenderIdResponse setDefaultSenderId(SetDefaultSenderIdRequest setDefaultSenderIdRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
- Parameters:
setDefaultSenderIdRequest
-- Returns:
- Result of the SetDefaultSenderId operation returned by the service.
- See Also:
-
setDefaultSenderId
default SetDefaultSenderIdResponse setDefaultSenderId(Consumer<SetDefaultSenderIdRequest.Builder> setDefaultSenderIdRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
This is a convenience which creates an instance of the
SetDefaultSenderIdRequest.Builder
avoiding the need to create one manually viaSetDefaultSenderIdRequest.builder()
- Parameters:
setDefaultSenderIdRequest
- AConsumer
that will call methods onSetDefaultSenderIdRequest.Builder
to create a request.- Returns:
- Result of the SetDefaultSenderId operation returned by the service.
- See Also:
-
setTextMessageSpendLimitOverride
default SetTextMessageSpendLimitOverrideResponse setTextMessageSpendLimitOverride(SetTextMessageSpendLimitOverrideRequest setTextMessageSpendLimitOverrideRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the
MaxLimit
, which is set by Amazon Web Services.- Parameters:
setTextMessageSpendLimitOverrideRequest
-- Returns:
- Result of the SetTextMessageSpendLimitOverride operation returned by the service.
- See Also:
-
setTextMessageSpendLimitOverride
default SetTextMessageSpendLimitOverrideResponse setTextMessageSpendLimitOverride(Consumer<SetTextMessageSpendLimitOverrideRequest.Builder> setTextMessageSpendLimitOverrideRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the
MaxLimit
, which is set by Amazon Web Services.
This is a convenience which creates an instance of the
SetTextMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaSetTextMessageSpendLimitOverrideRequest.builder()
- Parameters:
setTextMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onSetTextMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- Result of the SetTextMessageSpendLimitOverride operation returned by the service.
- See Also:
-
setVoiceMessageSpendLimitOverride
default SetVoiceMessageSpendLimitOverrideResponse setVoiceMessageSpendLimitOverride(SetVoiceMessageSpendLimitOverrideRequest setVoiceMessageSpendLimitOverrideRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the
MaxLimit
, which is set by Amazon Web Services.- Parameters:
setVoiceMessageSpendLimitOverrideRequest
-- Returns:
- Result of the SetVoiceMessageSpendLimitOverride operation returned by the service.
- See Also:
-
setVoiceMessageSpendLimitOverride
default SetVoiceMessageSpendLimitOverrideResponse setVoiceMessageSpendLimitOverride(Consumer<SetVoiceMessageSpendLimitOverrideRequest.Builder> setVoiceMessageSpendLimitOverrideRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the
MaxLimit
, which is set by Amazon Web Services.
This is a convenience which creates an instance of the
SetVoiceMessageSpendLimitOverrideRequest.Builder
avoiding the need to create one manually viaSetVoiceMessageSpendLimitOverrideRequest.builder()
- Parameters:
setVoiceMessageSpendLimitOverrideRequest
- AConsumer
that will call methods onSetVoiceMessageSpendLimitOverrideRequest.Builder
to create a request.- Returns:
- Result of the SetVoiceMessageSpendLimitOverride operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateEventDestination
default UpdateEventDestinationResponse updateEventDestination(UpdateEventDestinationRequest updateEventDestinationRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
- Parameters:
updateEventDestinationRequest
-- Returns:
- Result of the UpdateEventDestination operation returned by the service.
- See Also:
-
updateEventDestination
default UpdateEventDestinationResponse updateEventDestination(Consumer<UpdateEventDestinationRequest.Builder> updateEventDestinationRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
This is a convenience which creates an instance of the
UpdateEventDestinationRequest.Builder
avoiding the need to create one manually viaUpdateEventDestinationRequest.builder()
- Parameters:
updateEventDestinationRequest
- AConsumer
that will call methods onUpdateEventDestinationRequest.Builder
to create a request.- Returns:
- Result of the UpdateEventDestination operation returned by the service.
- See Also:
-
updatePhoneNumber
default UpdatePhoneNumberResponse updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an Error is returned.
- Parameters:
updatePhoneNumberRequest
-- Returns:
- Result of the UpdatePhoneNumber operation returned by the service.
- See Also:
-
updatePhoneNumber
default UpdatePhoneNumberResponse updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an Error is returned.
This is a convenience which creates an instance of the
UpdatePhoneNumberRequest.Builder
avoiding the need to create one manually viaUpdatePhoneNumberRequest.builder()
- Parameters:
updatePhoneNumberRequest
- AConsumer
that will call methods onUpdatePhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the UpdatePhoneNumber operation returned by the service.
- See Also:
-
updatePool
default UpdatePoolResponse updatePool(UpdatePoolRequest updatePoolRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the
TwoWayChannelArn
, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.- Parameters:
updatePoolRequest
-- Returns:
- Result of the UpdatePool operation returned by the service.
- See Also:
-
updatePool
default UpdatePoolResponse updatePool(Consumer<UpdatePoolRequest.Builder> updatePoolRequest) throws ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, PinpointSmsVoiceV2Exception Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the
TwoWayChannelArn
, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
This is a convenience which creates an instance of the
UpdatePoolRequest.Builder
avoiding the need to create one manually viaUpdatePoolRequest.builder()
- Parameters:
updatePoolRequest
- AConsumer
that will call methods onUpdatePoolRequest.Builder
to create a request.- Returns:
- Result of the UpdatePool operation returned by the service.
- See Also:
-
create
Create aPinpointSmsVoiceV2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPinpointSmsVoiceV2Client
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-