Interface SnsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AddPermissionResponse
addPermission
(Consumer<AddPermissionRequest.Builder> addPermissionRequest) Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.default AddPermissionResponse
addPermission
(AddPermissionRequest addPermissionRequest) Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.static SnsClientBuilder
builder()
Create a builder that can be used to configure and create aSnsClient
.checkIfPhoneNumberIsOptedOut
(Consumer<CheckIfPhoneNumberIsOptedOutRequest.Builder> checkIfPhoneNumberIsOptedOutRequest) Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account.checkIfPhoneNumberIsOptedOut
(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest) Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account.default ConfirmSubscriptionResponse
confirmSubscription
(Consumer<ConfirmSubscriptionRequest.Builder> confirmSubscriptionRequest) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlierSubscribe
action.default ConfirmSubscriptionResponse
confirmSubscription
(ConfirmSubscriptionRequest confirmSubscriptionRequest) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlierSubscribe
action.static SnsClient
create()
Create aSnsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createPlatformApplication
(Consumer<CreatePlatformApplicationRequest.Builder> createPlatformApplicationRequest) Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register.createPlatformApplication
(CreatePlatformApplicationRequest createPlatformApplicationRequest) Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register.default CreatePlatformEndpointResponse
createPlatformEndpoint
(Consumer<CreatePlatformEndpointRequest.Builder> createPlatformEndpointRequest) Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.default CreatePlatformEndpointResponse
createPlatformEndpoint
(CreatePlatformEndpointRequest createPlatformEndpointRequest) Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.createSMSSandboxPhoneNumber
(Consumer<CreateSmsSandboxPhoneNumberRequest.Builder> createSmsSandboxPhoneNumberRequest) Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.createSMSSandboxPhoneNumber
(CreateSmsSandboxPhoneNumberRequest createSmsSandboxPhoneNumberRequest) Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.default CreateTopicResponse
createTopic
(Consumer<CreateTopicRequest.Builder> createTopicRequest) Creates a topic to which notifications can be published.default CreateTopicResponse
createTopic
(CreateTopicRequest createTopicRequest) Creates a topic to which notifications can be published.default DeleteEndpointResponse
deleteEndpoint
(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) Deletes the endpoint for a device and mobile app from Amazon SNS.default DeleteEndpointResponse
deleteEndpoint
(DeleteEndpointRequest deleteEndpointRequest) Deletes the endpoint for a device and mobile app from Amazon SNS.deletePlatformApplication
(Consumer<DeletePlatformApplicationRequest.Builder> deletePlatformApplicationRequest) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).deletePlatformApplication
(DeletePlatformApplicationRequest deletePlatformApplicationRequest) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).deleteSMSSandboxPhoneNumber
(Consumer<DeleteSmsSandboxPhoneNumberRequest.Builder> deleteSmsSandboxPhoneNumberRequest) Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.deleteSMSSandboxPhoneNumber
(DeleteSmsSandboxPhoneNumberRequest deleteSmsSandboxPhoneNumberRequest) Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.default DeleteTopicResponse
deleteTopic
(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest) Deletes a topic and all its subscriptions.default DeleteTopicResponse
deleteTopic
(DeleteTopicRequest deleteTopicRequest) Deletes a topic and all its subscriptions.default GetDataProtectionPolicyResponse
getDataProtectionPolicy
(Consumer<GetDataProtectionPolicyRequest.Builder> getDataProtectionPolicyRequest) Retrieves the specified inlineDataProtectionPolicy
document that is stored in the specified Amazon SNS topic.default GetDataProtectionPolicyResponse
getDataProtectionPolicy
(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest) Retrieves the specified inlineDataProtectionPolicy
document that is stored in the specified Amazon SNS topic.default GetEndpointAttributesResponse
getEndpointAttributes
(Consumer<GetEndpointAttributesRequest.Builder> getEndpointAttributesRequest) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.default GetEndpointAttributesResponse
getEndpointAttributes
(GetEndpointAttributesRequest getEndpointAttributesRequest) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.getPlatformApplicationAttributes
(Consumer<GetPlatformApplicationAttributesRequest.Builder> getPlatformApplicationAttributesRequest) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).getPlatformApplicationAttributes
(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).default GetSmsAttributesResponse
Returns the settings for sending SMS messages from your Amazon Web Services account.default GetSmsAttributesResponse
getSMSAttributes
(Consumer<GetSmsAttributesRequest.Builder> getSmsAttributesRequest) Returns the settings for sending SMS messages from your Amazon Web Services account.default GetSmsAttributesResponse
getSMSAttributes
(GetSmsAttributesRequest getSmsAttributesRequest) Returns the settings for sending SMS messages from your Amazon Web Services account.getSMSSandboxAccountStatus
(Consumer<GetSmsSandboxAccountStatusRequest.Builder> getSmsSandboxAccountStatusRequest) Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.getSMSSandboxAccountStatus
(GetSmsSandboxAccountStatusRequest getSmsSandboxAccountStatusRequest) Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.getSubscriptionAttributes
(Consumer<GetSubscriptionAttributesRequest.Builder> getSubscriptionAttributesRequest) Returns all of the properties of a subscription.getSubscriptionAttributes
(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) Returns all of the properties of a subscription.default GetTopicAttributesResponse
getTopicAttributes
(Consumer<GetTopicAttributesRequest.Builder> getTopicAttributesRequest) Returns all of the properties of a topic.default GetTopicAttributesResponse
getTopicAttributes
(GetTopicAttributesRequest getTopicAttributesRequest) Returns all of the properties of a topic.listEndpointsByPlatformApplication
(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS.listEndpointsByPlatformApplication
(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS.listEndpointsByPlatformApplicationPaginator
(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest) This is a variant oflistEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
operation.listEndpointsByPlatformApplicationPaginator
(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) This is a variant oflistEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
operation.default ListOriginationNumbersResponse
listOriginationNumbers
(Consumer<ListOriginationNumbersRequest.Builder> listOriginationNumbersRequest) Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.default ListOriginationNumbersResponse
listOriginationNumbers
(ListOriginationNumbersRequest listOriginationNumbersRequest) Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.default ListOriginationNumbersIterable
listOriginationNumbersPaginator
(Consumer<ListOriginationNumbersRequest.Builder> listOriginationNumbersRequest) This is a variant oflistOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest)
operation.default ListOriginationNumbersIterable
listOriginationNumbersPaginator
(ListOriginationNumbersRequest listOriginationNumbersRequest) This is a variant oflistOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest)
operation.default ListPhoneNumbersOptedOutResponse
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.default ListPhoneNumbersOptedOutResponse
listPhoneNumbersOptedOut
(Consumer<ListPhoneNumbersOptedOutRequest.Builder> listPhoneNumbersOptedOutRequest) Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.default ListPhoneNumbersOptedOutResponse
listPhoneNumbersOptedOut
(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest) Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.default ListPhoneNumbersOptedOutIterable
This is a variant oflistPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
operation.default ListPhoneNumbersOptedOutIterable
listPhoneNumbersOptedOutPaginator
(Consumer<ListPhoneNumbersOptedOutRequest.Builder> listPhoneNumbersOptedOutRequest) This is a variant oflistPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
operation.default ListPhoneNumbersOptedOutIterable
listPhoneNumbersOptedOutPaginator
(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest) This is a variant oflistPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
operation.default ListPlatformApplicationsResponse
Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).default ListPlatformApplicationsResponse
listPlatformApplications
(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest) Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).default ListPlatformApplicationsResponse
listPlatformApplications
(ListPlatformApplicationsRequest listPlatformApplicationsRequest) Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).default ListPlatformApplicationsIterable
This is a variant oflistPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.default ListPlatformApplicationsIterable
listPlatformApplicationsPaginator
(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest) This is a variant oflistPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.default ListPlatformApplicationsIterable
listPlatformApplicationsPaginator
(ListPlatformApplicationsRequest listPlatformApplicationsRequest) This is a variant oflistPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.listSMSSandboxPhoneNumbers
(Consumer<ListSmsSandboxPhoneNumbersRequest.Builder> listSmsSandboxPhoneNumbersRequest) Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.listSMSSandboxPhoneNumbers
(ListSmsSandboxPhoneNumbersRequest listSmsSandboxPhoneNumbersRequest) Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.listSMSSandboxPhoneNumbersPaginator
(Consumer<ListSmsSandboxPhoneNumbersRequest.Builder> listSmsSandboxPhoneNumbersRequest) This is a variant oflistSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest)
operation.listSMSSandboxPhoneNumbersPaginator
(ListSmsSandboxPhoneNumbersRequest listSmsSandboxPhoneNumbersRequest) This is a variant oflistSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest)
operation.default ListSubscriptionsResponse
Returns a list of the requester's subscriptions.default ListSubscriptionsResponse
listSubscriptions
(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) Returns a list of the requester's subscriptions.default ListSubscriptionsResponse
listSubscriptions
(ListSubscriptionsRequest listSubscriptionsRequest) Returns a list of the requester's subscriptions.default ListSubscriptionsByTopicResponse
listSubscriptionsByTopic
(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest) Returns a list of the subscriptions to a specific topic.default ListSubscriptionsByTopicResponse
listSubscriptionsByTopic
(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) Returns a list of the subscriptions to a specific topic.default ListSubscriptionsByTopicIterable
listSubscriptionsByTopicPaginator
(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest) This is a variant oflistSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
operation.default ListSubscriptionsByTopicIterable
listSubscriptionsByTopicPaginator
(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) This is a variant oflistSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
operation.default ListSubscriptionsIterable
This is a variant oflistSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
operation.default ListSubscriptionsIterable
listSubscriptionsPaginator
(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) This is a variant oflistSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
operation.default ListSubscriptionsIterable
listSubscriptionsPaginator
(ListSubscriptionsRequest listSubscriptionsRequest) This is a variant oflistSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags added to the specified Amazon SNS topic.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List all tags added to the specified Amazon SNS topic.default ListTopicsResponse
Returns a list of the requester's topics.default ListTopicsResponse
listTopics
(Consumer<ListTopicsRequest.Builder> listTopicsRequest) Returns a list of the requester's topics.default ListTopicsResponse
listTopics
(ListTopicsRequest listTopicsRequest) Returns a list of the requester's topics.default ListTopicsIterable
This is a variant oflistTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
operation.default ListTopicsIterable
listTopicsPaginator
(Consumer<ListTopicsRequest.Builder> listTopicsRequest) This is a variant oflistTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
operation.default ListTopicsIterable
listTopicsPaginator
(ListTopicsRequest listTopicsRequest) This is a variant oflistTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
operation.default OptInPhoneNumberResponse
optInPhoneNumber
(Consumer<OptInPhoneNumberRequest.Builder> optInPhoneNumberRequest) Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.default OptInPhoneNumberResponse
optInPhoneNumber
(OptInPhoneNumberRequest optInPhoneNumberRequest) Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.default PublishResponse
publish
(Consumer<PublishRequest.Builder> publishRequest) Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify theTargetArn
).default PublishResponse
publish
(PublishRequest publishRequest) Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify theTargetArn
).default PublishBatchResponse
publishBatch
(Consumer<PublishBatchRequest.Builder> publishBatchRequest) Publishes up to ten messages to the specified topic.default PublishBatchResponse
publishBatch
(PublishBatchRequest publishBatchRequest) Publishes up to ten messages to the specified topic.default PutDataProtectionPolicyResponse
putDataProtectionPolicy
(Consumer<PutDataProtectionPolicyRequest.Builder> putDataProtectionPolicyRequest) Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.default PutDataProtectionPolicyResponse
putDataProtectionPolicy
(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest) Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.default RemovePermissionResponse
removePermission
(Consumer<RemovePermissionRequest.Builder> removePermissionRequest) Removes a statement from a topic's access control policy.default RemovePermissionResponse
removePermission
(RemovePermissionRequest removePermissionRequest) Removes a statement from a topic's access control policy.default SnsServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SetEndpointAttributesResponse
setEndpointAttributes
(Consumer<SetEndpointAttributesRequest.Builder> setEndpointAttributesRequest) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.default SetEndpointAttributesResponse
setEndpointAttributes
(SetEndpointAttributesRequest setEndpointAttributesRequest) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.setPlatformApplicationAttributes
(Consumer<SetPlatformApplicationAttributesRequest.Builder> setPlatformApplicationAttributesRequest) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).setPlatformApplicationAttributes
(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).default SetSmsAttributesResponse
setSMSAttributes
(Consumer<SetSmsAttributesRequest.Builder> setSmsAttributesRequest) Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.default SetSmsAttributesResponse
setSMSAttributes
(SetSmsAttributesRequest setSmsAttributesRequest) Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.setSubscriptionAttributes
(Consumer<SetSubscriptionAttributesRequest.Builder> setSubscriptionAttributesRequest) Allows a subscription owner to set an attribute of the subscription to a new value.setSubscriptionAttributes
(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) Allows a subscription owner to set an attribute of the subscription to a new value.default SetTopicAttributesResponse
setTopicAttributes
(Consumer<SetTopicAttributesRequest.Builder> setTopicAttributesRequest) Allows a topic owner to set an attribute of the topic to a new value.default SetTopicAttributesResponse
setTopicAttributes
(SetTopicAttributesRequest setTopicAttributesRequest) Allows a topic owner to set an attribute of the topic to a new value.default SubscribeResponse
subscribe
(Consumer<SubscribeRequest.Builder> subscribeRequest) Subscribes an endpoint to an Amazon SNS topic.default SubscribeResponse
subscribe
(SubscribeRequest subscribeRequest) Subscribes an endpoint to an Amazon SNS topic.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add tags to the specified Amazon SNS topic.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Add tags to the specified Amazon SNS topic.default UnsubscribeResponse
unsubscribe
(Consumer<UnsubscribeRequest.Builder> unsubscribeRequest) Deletes a subscription.default UnsubscribeResponse
unsubscribe
(UnsubscribeRequest unsubscribeRequest) Deletes a subscription.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from the specified Amazon SNS topic.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Remove tags from the specified Amazon SNS topic.verifySMSSandboxPhoneNumber
(Consumer<VerifySmsSandboxPhoneNumberRequest.Builder> verifySmsSandboxPhoneNumberRequest) Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.verifySMSSandboxPhoneNumber
(VerifySmsSandboxPhoneNumberRequest verifySmsSandboxPhoneNumberRequest) Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.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
-
addPermission
default AddPermissionResponse addPermission(AddPermissionRequest addPermissionRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
To remove the ability to change topic permissions, you must deny permissions to the
AddPermission
,RemovePermission
, andSetTopicAttributes
actions in your IAM policy.- Parameters:
addPermissionRequest
-- Returns:
- Result of the AddPermission operation returned by the service.
- See Also:
-
addPermission
default AddPermissionResponse addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
To remove the ability to change topic permissions, you must deny permissions to the
AddPermission
,RemovePermission
, andSetTopicAttributes
actions in your IAM policy.
This is a convenience which creates an instance of the
AddPermissionRequest.Builder
avoiding the need to create one manually viaAddPermissionRequest.builder()
- Parameters:
addPermissionRequest
- AConsumer
that will call methods onAddPermissionRequest.Builder
to create a request.- Returns:
- Result of the AddPermission operation returned by the service.
- See Also:
-
checkIfPhoneNumberIsOptedOut
default CheckIfPhoneNumberIsOptedOutResponse checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the
OptInPhoneNumber
action.- Parameters:
checkIfPhoneNumberIsOptedOutRequest
- The input for theCheckIfPhoneNumberIsOptedOut
action.- Returns:
- Result of the CheckIfPhoneNumberIsOptedOut operation returned by the service.
- See Also:
-
checkIfPhoneNumberIsOptedOut
default CheckIfPhoneNumberIsOptedOutResponse checkIfPhoneNumberIsOptedOut(Consumer<CheckIfPhoneNumberIsOptedOutRequest.Builder> checkIfPhoneNumberIsOptedOutRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the
OptInPhoneNumber
action.
This is a convenience which creates an instance of the
CheckIfPhoneNumberIsOptedOutRequest.Builder
avoiding the need to create one manually viaCheckIfPhoneNumberIsOptedOutRequest.builder()
- Parameters:
checkIfPhoneNumberIsOptedOutRequest
- AConsumer
that will call methods onCheckIfPhoneNumberIsOptedOutRequest.Builder
to create a request. The input for theCheckIfPhoneNumberIsOptedOut
action.- Returns:
- Result of the CheckIfPhoneNumberIsOptedOut operation returned by the service.
- See Also:
-
confirmSubscription
default ConfirmSubscriptionResponse confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest) throws SubscriptionLimitExceededException, InvalidParameterException, NotFoundException, InternalErrorException, AuthorizationErrorException, FilterPolicyLimitExceededException, ReplayLimitExceededException, AwsServiceException, SdkClientException, SnsException Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier
Subscribe
action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when theAuthenticateOnUnsubscribe
flag is set to "true".- Parameters:
confirmSubscriptionRequest
- Input for ConfirmSubscription action.- Returns:
- Result of the ConfirmSubscription operation returned by the service.
- See Also:
-
confirmSubscription
default ConfirmSubscriptionResponse confirmSubscription(Consumer<ConfirmSubscriptionRequest.Builder> confirmSubscriptionRequest) throws SubscriptionLimitExceededException, InvalidParameterException, NotFoundException, InternalErrorException, AuthorizationErrorException, FilterPolicyLimitExceededException, ReplayLimitExceededException, AwsServiceException, SdkClientException, SnsException Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier
Subscribe
action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when theAuthenticateOnUnsubscribe
flag is set to "true".
This is a convenience which creates an instance of the
ConfirmSubscriptionRequest.Builder
avoiding the need to create one manually viaConfirmSubscriptionRequest.builder()
- Parameters:
confirmSubscriptionRequest
- AConsumer
that will call methods onConfirmSubscriptionRequest.Builder
to create a request. Input for ConfirmSubscription action.- Returns:
- Result of the ConfirmSubscription operation returned by the service.
- See Also:
-
createPlatformApplication
default CreatePlatformApplicationResponse createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify
PlatformPrincipal
andPlatformCredential
attributes when using theCreatePlatformApplication
action.PlatformPrincipal
andPlatformCredential
are received from the notification service.-
For
ADM
,PlatformPrincipal
isclient id
andPlatformCredential
isclient secret
. -
For
Baidu
,PlatformPrincipal
isAPI key
andPlatformCredential
issecret key
. -
For
APNS
andAPNS_SANDBOX
using certificate credentials,PlatformPrincipal
isSSL certificate
andPlatformCredential
isprivate key
. -
For
APNS
andAPNS_SANDBOX
using token credentials,PlatformPrincipal
issigning key ID
andPlatformCredential
issigning key
. -
For GCM (Firebase Cloud Messaging) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
. -
For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
. -
For
MPNS
,PlatformPrincipal
isTLS certificate
andPlatformCredential
isprivate key
. -
For
WNS
,PlatformPrincipal
isPackage Security Identifier
andPlatformCredential
issecret key
.
You can use the returned
PlatformApplicationArn
as an attribute for theCreatePlatformEndpoint
action.- Parameters:
createPlatformApplicationRequest
- Input for CreatePlatformApplication action.- Returns:
- Result of the CreatePlatformApplication operation returned by the service.
- See Also:
-
-
createPlatformApplication
default CreatePlatformApplicationResponse createPlatformApplication(Consumer<CreatePlatformApplicationRequest.Builder> createPlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify
PlatformPrincipal
andPlatformCredential
attributes when using theCreatePlatformApplication
action.PlatformPrincipal
andPlatformCredential
are received from the notification service.-
For
ADM
,PlatformPrincipal
isclient id
andPlatformCredential
isclient secret
. -
For
Baidu
,PlatformPrincipal
isAPI key
andPlatformCredential
issecret key
. -
For
APNS
andAPNS_SANDBOX
using certificate credentials,PlatformPrincipal
isSSL certificate
andPlatformCredential
isprivate key
. -
For
APNS
andAPNS_SANDBOX
using token credentials,PlatformPrincipal
issigning key ID
andPlatformCredential
issigning key
. -
For GCM (Firebase Cloud Messaging) using key credentials, there is no
PlatformPrincipal
. ThePlatformCredential
isAPI key
. -
For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal
. ThePlatformCredential
is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command:SERVICE_JSON=`jq @json <<< cat service.json`
. -
For
MPNS
,PlatformPrincipal
isTLS certificate
andPlatformCredential
isprivate key
. -
For
WNS
,PlatformPrincipal
isPackage Security Identifier
andPlatformCredential
issecret key
.
You can use the returned
PlatformApplicationArn
as an attribute for theCreatePlatformEndpoint
action.
This is a convenience which creates an instance of the
CreatePlatformApplicationRequest.Builder
avoiding the need to create one manually viaCreatePlatformApplicationRequest.builder()
- Parameters:
createPlatformApplicationRequest
- AConsumer
that will call methods onCreatePlatformApplicationRequest.Builder
to create a request. Input for CreatePlatformApplication action.- Returns:
- Result of the CreatePlatformApplication operation returned by the service.
- See Also:
-
-
createPlatformEndpoint
default CreatePlatformEndpointResponse createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
CreatePlatformEndpoint
requires thePlatformApplicationArn
that is returned fromCreatePlatformApplication
. You can use the returnedEndpointArn
to send a message to a mobile app or by theSubscribe
action for subscription to a topic. TheCreatePlatformEndpoint
action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.When using
CreatePlatformEndpoint
with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.- Parameters:
createPlatformEndpointRequest
- Input for CreatePlatformEndpoint action.- Returns:
- Result of the CreatePlatformEndpoint operation returned by the service.
- See Also:
-
createPlatformEndpoint
default CreatePlatformEndpointResponse createPlatformEndpoint(Consumer<CreatePlatformEndpointRequest.Builder> createPlatformEndpointRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
CreatePlatformEndpoint
requires thePlatformApplicationArn
that is returned fromCreatePlatformApplication
. You can use the returnedEndpointArn
to send a message to a mobile app or by theSubscribe
action for subscription to a topic. TheCreatePlatformEndpoint
action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.When using
CreatePlatformEndpoint
with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
This is a convenience which creates an instance of the
CreatePlatformEndpointRequest.Builder
avoiding the need to create one manually viaCreatePlatformEndpointRequest.builder()
- Parameters:
createPlatformEndpointRequest
- AConsumer
that will call methods onCreatePlatformEndpointRequest.Builder
to create a request. Input for CreatePlatformEndpoint action.- Returns:
- Result of the CreatePlatformEndpoint operation returned by the service.
- See Also:
-
createSMSSandboxPhoneNumber
default CreateSmsSandboxPhoneNumberResponse createSMSSandboxPhoneNumber(CreateSmsSandboxPhoneNumberRequest createSmsSandboxPhoneNumberRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, OptedOutException, UserErrorException, ThrottledException, AwsServiceException, SdkClientException, SnsException Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
- Parameters:
createSmsSandboxPhoneNumberRequest
-- Returns:
- Result of the CreateSMSSandboxPhoneNumber operation returned by the service.
- See Also:
-
createSMSSandboxPhoneNumber
default CreateSmsSandboxPhoneNumberResponse createSMSSandboxPhoneNumber(Consumer<CreateSmsSandboxPhoneNumberRequest.Builder> createSmsSandboxPhoneNumberRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, OptedOutException, UserErrorException, ThrottledException, AwsServiceException, SdkClientException, SnsException Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
This is a convenience which creates an instance of the
CreateSmsSandboxPhoneNumberRequest.Builder
avoiding the need to create one manually viaCreateSmsSandboxPhoneNumberRequest.builder()
- Parameters:
createSmsSandboxPhoneNumberRequest
- AConsumer
that will call methods onCreateSmsSandboxPhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the CreateSMSSandboxPhoneNumber operation returned by the service.
- See Also:
-
createTopic
default CreateTopicResponse createTopic(CreateTopicRequest createTopicRequest) throws InvalidParameterException, TopicLimitExceededException, InternalErrorException, AuthorizationErrorException, InvalidSecurityException, TagLimitExceededException, StaleTagException, TagPolicyException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
- Parameters:
createTopicRequest
- Input for CreateTopic action.- Returns:
- Result of the CreateTopic operation returned by the service.
- See Also:
-
createTopic
default CreateTopicResponse createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest) throws InvalidParameterException, TopicLimitExceededException, InternalErrorException, AuthorizationErrorException, InvalidSecurityException, TagLimitExceededException, StaleTagException, TagPolicyException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
This is a convenience which creates an instance of the
CreateTopicRequest.Builder
avoiding the need to create one manually viaCreateTopicRequest.builder()
- Parameters:
createTopicRequest
- AConsumer
that will call methods onCreateTopicRequest.Builder
to create a request. Input for CreateTopic action.- Returns:
- Result of the CreateTopic operation returned by the service.
- See Also:
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
- Parameters:
deleteEndpointRequest
- Input forDeleteEndpoint
action.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
This is a convenience which creates an instance of the
DeleteEndpointRequest.Builder
avoiding the need to create one manually viaDeleteEndpointRequest.builder()
- Parameters:
deleteEndpointRequest
- AConsumer
that will call methods onDeleteEndpointRequest.Builder
to create a request. Input forDeleteEndpoint
action.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
deletePlatformApplication
default DeletePlatformApplicationResponse deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
- Parameters:
deletePlatformApplicationRequest
- Input forDeletePlatformApplication
action.- Returns:
- Result of the DeletePlatformApplication operation returned by the service.
- See Also:
-
deletePlatformApplication
default DeletePlatformApplicationResponse deletePlatformApplication(Consumer<DeletePlatformApplicationRequest.Builder> deletePlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
This is a convenience which creates an instance of the
DeletePlatformApplicationRequest.Builder
avoiding the need to create one manually viaDeletePlatformApplicationRequest.builder()
- Parameters:
deletePlatformApplicationRequest
- AConsumer
that will call methods onDeletePlatformApplicationRequest.Builder
to create a request. Input forDeletePlatformApplication
action.- Returns:
- Result of the DeletePlatformApplication operation returned by the service.
- See Also:
-
deleteSMSSandboxPhoneNumber
default DeleteSmsSandboxPhoneNumberResponse deleteSMSSandboxPhoneNumber(DeleteSmsSandboxPhoneNumberRequest deleteSmsSandboxPhoneNumberRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, ResourceNotFoundException, UserErrorException, ThrottledException, AwsServiceException, SdkClientException, SnsException Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
- Parameters:
deleteSmsSandboxPhoneNumberRequest
-- Returns:
- Result of the DeleteSMSSandboxPhoneNumber operation returned by the service.
- See Also:
-
deleteSMSSandboxPhoneNumber
default DeleteSmsSandboxPhoneNumberResponse deleteSMSSandboxPhoneNumber(Consumer<DeleteSmsSandboxPhoneNumberRequest.Builder> deleteSmsSandboxPhoneNumberRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, ResourceNotFoundException, UserErrorException, ThrottledException, AwsServiceException, SdkClientException, SnsException Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
This is a convenience which creates an instance of the
DeleteSmsSandboxPhoneNumberRequest.Builder
avoiding the need to create one manually viaDeleteSmsSandboxPhoneNumberRequest.builder()
- Parameters:
deleteSmsSandboxPhoneNumberRequest
- AConsumer
that will call methods onDeleteSmsSandboxPhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the DeleteSMSSandboxPhoneNumber operation returned by the service.
- See Also:
-
deleteTopic
default DeleteTopicResponse deleteTopic(DeleteTopicRequest deleteTopicRequest) throws InvalidParameterException, InvalidStateException, InternalErrorException, AuthorizationErrorException, NotFoundException, StaleTagException, TagPolicyException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
- Parameters:
deleteTopicRequest
-- Returns:
- Result of the DeleteTopic operation returned by the service.
- See Also:
-
deleteTopic
default DeleteTopicResponse deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest) throws InvalidParameterException, InvalidStateException, InternalErrorException, AuthorizationErrorException, NotFoundException, StaleTagException, TagPolicyException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
This is a convenience which creates an instance of the
DeleteTopicRequest.Builder
avoiding the need to create one manually viaDeleteTopicRequest.builder()
- Parameters:
deleteTopicRequest
- AConsumer
that will call methods onDeleteTopicRequest.Builder
to create a request.- Returns:
- Result of the DeleteTopic operation returned by the service.
- See Also:
-
getDataProtectionPolicy
default GetDataProtectionPolicyResponse getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Retrieves the specified inline
DataProtectionPolicy
document that is stored in the specified Amazon SNS topic.- Parameters:
getDataProtectionPolicyRequest
-- Returns:
- Result of the GetDataProtectionPolicy operation returned by the service.
- See Also:
-
getDataProtectionPolicy
default GetDataProtectionPolicyResponse getDataProtectionPolicy(Consumer<GetDataProtectionPolicyRequest.Builder> getDataProtectionPolicyRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Retrieves the specified inline
DataProtectionPolicy
document that is stored in the specified Amazon SNS topic.
This is a convenience which creates an instance of the
GetDataProtectionPolicyRequest.Builder
avoiding the need to create one manually viaGetDataProtectionPolicyRequest.builder()
- Parameters:
getDataProtectionPolicyRequest
- AConsumer
that will call methods onGetDataProtectionPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetDataProtectionPolicy operation returned by the service.
- See Also:
-
getEndpointAttributes
default GetEndpointAttributesResponse getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
- Parameters:
getEndpointAttributesRequest
- Input forGetEndpointAttributes
action.- Returns:
- Result of the GetEndpointAttributes operation returned by the service.
- See Also:
-
getEndpointAttributes
default GetEndpointAttributesResponse getEndpointAttributes(Consumer<GetEndpointAttributesRequest.Builder> getEndpointAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
This is a convenience which creates an instance of the
GetEndpointAttributesRequest.Builder
avoiding the need to create one manually viaGetEndpointAttributesRequest.builder()
- Parameters:
getEndpointAttributesRequest
- AConsumer
that will call methods onGetEndpointAttributesRequest.Builder
to create a request. Input forGetEndpointAttributes
action.- Returns:
- Result of the GetEndpointAttributes operation returned by the service.
- See Also:
-
getPlatformApplicationAttributes
default GetPlatformApplicationAttributesResponse getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
- Parameters:
getPlatformApplicationAttributesRequest
- Input forGetPlatformApplicationAttributes
action.- Returns:
- Result of the GetPlatformApplicationAttributes operation returned by the service.
- See Also:
-
getPlatformApplicationAttributes
default GetPlatformApplicationAttributesResponse getPlatformApplicationAttributes(Consumer<GetPlatformApplicationAttributesRequest.Builder> getPlatformApplicationAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
This is a convenience which creates an instance of the
GetPlatformApplicationAttributesRequest.Builder
avoiding the need to create one manually viaGetPlatformApplicationAttributesRequest.builder()
- Parameters:
getPlatformApplicationAttributesRequest
- AConsumer
that will call methods onGetPlatformApplicationAttributesRequest.Builder
to create a request. Input forGetPlatformApplicationAttributes
action.- Returns:
- Result of the GetPlatformApplicationAttributes operation returned by the service.
- See Also:
-
getSMSAttributes
default GetSmsAttributesResponse getSMSAttributes(GetSmsAttributesRequest getSmsAttributesRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException Returns the settings for sending SMS messages from your Amazon Web Services account.
These settings are set with the
SetSMSAttributes
action.- Parameters:
getSmsAttributesRequest
- The input for theGetSMSAttributes
request.- Returns:
- Result of the GetSMSAttributes operation returned by the service.
- See Also:
-
getSMSAttributes
default GetSmsAttributesResponse getSMSAttributes(Consumer<GetSmsAttributesRequest.Builder> getSmsAttributesRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException Returns the settings for sending SMS messages from your Amazon Web Services account.
These settings are set with the
SetSMSAttributes
action.
This is a convenience which creates an instance of the
GetSmsAttributesRequest.Builder
avoiding the need to create one manually viaGetSmsAttributesRequest.builder()
- Parameters:
getSmsAttributesRequest
- AConsumer
that will call methods onGetSmsAttributesRequest.Builder
to create a request. The input for theGetSMSAttributes
request.- Returns:
- Result of the GetSMSAttributes operation returned by the service.
- See Also:
-
getSMSAttributes
default GetSmsAttributesResponse getSMSAttributes() throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsExceptionReturns the settings for sending SMS messages from your Amazon Web Services account.
These settings are set with the
SetSMSAttributes
action.- Returns:
- Result of the GetSMSAttributes operation returned by the service.
- See Also:
-
getSMSSandboxAccountStatus
default GetSmsSandboxAccountStatusResponse getSMSSandboxAccountStatus(GetSmsSandboxAccountStatusRequest getSmsSandboxAccountStatusRequest) throws AuthorizationErrorException, InternalErrorException, ThrottledException, AwsServiceException, SdkClientException, SnsException Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
- Parameters:
getSmsSandboxAccountStatusRequest
-- Returns:
- Result of the GetSMSSandboxAccountStatus operation returned by the service.
- See Also:
-
getSMSSandboxAccountStatus
default GetSmsSandboxAccountStatusResponse getSMSSandboxAccountStatus(Consumer<GetSmsSandboxAccountStatusRequest.Builder> getSmsSandboxAccountStatusRequest) throws AuthorizationErrorException, InternalErrorException, ThrottledException, AwsServiceException, SdkClientException, SnsException Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
This is a convenience which creates an instance of the
GetSmsSandboxAccountStatusRequest.Builder
avoiding the need to create one manually viaGetSmsSandboxAccountStatusRequest.builder()
- Parameters:
getSmsSandboxAccountStatusRequest
- AConsumer
that will call methods onGetSmsSandboxAccountStatusRequest.Builder
to create a request.- Returns:
- Result of the GetSMSSandboxAccountStatus operation returned by the service.
- See Also:
-
getSubscriptionAttributes
default GetSubscriptionAttributesResponse getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Returns all of the properties of a subscription.
- Parameters:
getSubscriptionAttributesRequest
- Input for GetSubscriptionAttributes.- Returns:
- Result of the GetSubscriptionAttributes operation returned by the service.
- See Also:
-
getSubscriptionAttributes
default GetSubscriptionAttributesResponse getSubscriptionAttributes(Consumer<GetSubscriptionAttributesRequest.Builder> getSubscriptionAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Returns all of the properties of a subscription.
This is a convenience which creates an instance of the
GetSubscriptionAttributesRequest.Builder
avoiding the need to create one manually viaGetSubscriptionAttributesRequest.builder()
- Parameters:
getSubscriptionAttributesRequest
- AConsumer
that will call methods onGetSubscriptionAttributesRequest.Builder
to create a request. Input for GetSubscriptionAttributes.- Returns:
- Result of the GetSubscriptionAttributes operation returned by the service.
- See Also:
-
getTopicAttributes
default GetTopicAttributesResponse getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
- Parameters:
getTopicAttributesRequest
- Input for GetTopicAttributes action.- Returns:
- Result of the GetTopicAttributes operation returned by the service.
- See Also:
-
getTopicAttributes
default GetTopicAttributesResponse getTopicAttributes(Consumer<GetTopicAttributesRequest.Builder> getTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
This is a convenience which creates an instance of the
GetTopicAttributesRequest.Builder
avoiding the need to create one manually viaGetTopicAttributesRequest.builder()
- Parameters:
getTopicAttributesRequest
- AConsumer
that will call methods onGetTopicAttributesRequest.Builder
to create a request. Input for GetTopicAttributes action.- Returns:
- Result of the GetTopicAttributes operation returned by the service.
- See Also:
-
listEndpointsByPlatformApplication
default ListEndpointsByPlatformApplicationResponse listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for
ListEndpointsByPlatformApplication
are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you callListEndpointsByPlatformApplication
again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.This action is throttled at 30 transactions per second (TPS).
- Parameters:
listEndpointsByPlatformApplicationRequest
- Input forListEndpointsByPlatformApplication
action.- Returns:
- Result of the ListEndpointsByPlatformApplication operation returned by the service.
- See Also:
-
listEndpointsByPlatformApplication
default ListEndpointsByPlatformApplicationResponse listEndpointsByPlatformApplication(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for
ListEndpointsByPlatformApplication
are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you callListEndpointsByPlatformApplication
again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.This action is throttled at 30 transactions per second (TPS).
This is a convenience which creates an instance of the
ListEndpointsByPlatformApplicationRequest.Builder
avoiding the need to create one manually viaListEndpointsByPlatformApplicationRequest.builder()
- Parameters:
listEndpointsByPlatformApplicationRequest
- AConsumer
that will call methods onListEndpointsByPlatformApplicationRequest.Builder
to create a request. Input forListEndpointsByPlatformApplication
action.- Returns:
- Result of the ListEndpointsByPlatformApplication operation returned by the service.
- See Also:
-
listEndpointsByPlatformApplicationPaginator
default ListEndpointsByPlatformApplicationIterable listEndpointsByPlatformApplicationPaginator(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException This is a variant of
listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
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.sns.paginators.ListEndpointsByPlatformApplicationIterable responses = client.listEndpointsByPlatformApplicationPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationIterable responses = client .listEndpointsByPlatformApplicationPaginator(request); for (software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationIterable responses = client.listEndpointsByPlatformApplicationPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
operation.- Parameters:
listEndpointsByPlatformApplicationRequest
- Input forListEndpointsByPlatformApplication
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEndpointsByPlatformApplicationPaginator
default ListEndpointsByPlatformApplicationIterable listEndpointsByPlatformApplicationPaginator(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException This is a variant of
listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
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.sns.paginators.ListEndpointsByPlatformApplicationIterable responses = client.listEndpointsByPlatformApplicationPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationIterable responses = client .listEndpointsByPlatformApplicationPaginator(request); for (software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationIterable responses = client.listEndpointsByPlatformApplicationPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest)
operation.
This is a convenience which creates an instance of the
ListEndpointsByPlatformApplicationRequest.Builder
avoiding the need to create one manually viaListEndpointsByPlatformApplicationRequest.builder()
- Parameters:
listEndpointsByPlatformApplicationRequest
- AConsumer
that will call methods onListEndpointsByPlatformApplicationRequest.Builder
to create a request. Input forListEndpointsByPlatformApplication
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listOriginationNumbers
default ListOriginationNumbersResponse listOriginationNumbers(ListOriginationNumbersRequest listOriginationNumbersRequest) throws InternalErrorException, AuthorizationErrorException, ThrottledException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, SnsException Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
- Parameters:
listOriginationNumbersRequest
-- Returns:
- Result of the ListOriginationNumbers operation returned by the service.
- See Also:
-
listOriginationNumbers
default ListOriginationNumbersResponse listOriginationNumbers(Consumer<ListOriginationNumbersRequest.Builder> listOriginationNumbersRequest) throws InternalErrorException, AuthorizationErrorException, ThrottledException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, SnsException Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
This is a convenience which creates an instance of the
ListOriginationNumbersRequest.Builder
avoiding the need to create one manually viaListOriginationNumbersRequest.builder()
- Parameters:
listOriginationNumbersRequest
- AConsumer
that will call methods onListOriginationNumbersRequest.Builder
to create a request.- Returns:
- Result of the ListOriginationNumbers operation returned by the service.
- See Also:
-
listOriginationNumbersPaginator
default ListOriginationNumbersIterable listOriginationNumbersPaginator(ListOriginationNumbersRequest listOriginationNumbersRequest) throws InternalErrorException, AuthorizationErrorException, ThrottledException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, SnsException This is a variant of
listOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest)
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.sns.paginators.ListOriginationNumbersIterable responses = client.listOriginationNumbersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListOriginationNumbersIterable responses = client .listOriginationNumbersPaginator(request); for (software.amazon.awssdk.services.sns.model.ListOriginationNumbersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListOriginationNumbersIterable responses = client.listOriginationNumbersPaginator(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
listOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest)
operation.- Parameters:
listOriginationNumbersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listOriginationNumbersPaginator
default ListOriginationNumbersIterable listOriginationNumbersPaginator(Consumer<ListOriginationNumbersRequest.Builder> listOriginationNumbersRequest) throws InternalErrorException, AuthorizationErrorException, ThrottledException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, SnsException This is a variant of
listOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest)
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.sns.paginators.ListOriginationNumbersIterable responses = client.listOriginationNumbersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListOriginationNumbersIterable responses = client .listOriginationNumbersPaginator(request); for (software.amazon.awssdk.services.sns.model.ListOriginationNumbersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListOriginationNumbersIterable responses = client.listOriginationNumbersPaginator(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
listOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest)
operation.
This is a convenience which creates an instance of the
ListOriginationNumbersRequest.Builder
avoiding the need to create one manually viaListOriginationNumbersRequest.builder()
- Parameters:
listOriginationNumbersRequest
- AConsumer
that will call methods onListOriginationNumbersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPhoneNumbersOptedOut
default ListPhoneNumbersOptedOutResponse listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for
ListPhoneNumbersOptedOut
are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then aNextToken
string will be returned. To receive the next page, you callListPhoneNumbersOptedOut
again using theNextToken
string received from the previous call. When there are no more records to return,NextToken
will be null.- Parameters:
listPhoneNumbersOptedOutRequest
- The input for theListPhoneNumbersOptedOut
action.- Returns:
- Result of the ListPhoneNumbersOptedOut operation returned by the service.
- See Also:
-
listPhoneNumbersOptedOut
default ListPhoneNumbersOptedOutResponse listPhoneNumbersOptedOut(Consumer<ListPhoneNumbersOptedOutRequest.Builder> listPhoneNumbersOptedOutRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for
ListPhoneNumbersOptedOut
are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then aNextToken
string will be returned. To receive the next page, you callListPhoneNumbersOptedOut
again using theNextToken
string received from the previous call. When there are no more records to return,NextToken
will be null.
This is a convenience which creates an instance of the
ListPhoneNumbersOptedOutRequest.Builder
avoiding the need to create one manually viaListPhoneNumbersOptedOutRequest.builder()
- Parameters:
listPhoneNumbersOptedOutRequest
- AConsumer
that will call methods onListPhoneNumbersOptedOutRequest.Builder
to create a request. The input for theListPhoneNumbersOptedOut
action.- Returns:
- Result of the ListPhoneNumbersOptedOut operation returned by the service.
- See Also:
-
listPhoneNumbersOptedOut
default ListPhoneNumbersOptedOutResponse listPhoneNumbersOptedOut() throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsExceptionReturns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for
ListPhoneNumbersOptedOut
are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then aNextToken
string will be returned. To receive the next page, you callListPhoneNumbersOptedOut
again using theNextToken
string received from the previous call. When there are no more records to return,NextToken
will be null.- Returns:
- Result of the ListPhoneNumbersOptedOut operation returned by the service.
- See Also:
-
listPhoneNumbersOptedOutPaginator
default ListPhoneNumbersOptedOutIterable listPhoneNumbersOptedOutPaginator() throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsExceptionThis is a variant of
listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
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.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client .listPhoneNumbersOptedOutPaginator(request); for (software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPhoneNumbersOptedOutPaginator
default ListPhoneNumbersOptedOutIterable listPhoneNumbersOptedOutPaginator(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException This is a variant of
listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
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.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client .listPhoneNumbersOptedOutPaginator(request); for (software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
operation.- Parameters:
listPhoneNumbersOptedOutRequest
- The input for theListPhoneNumbersOptedOut
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPhoneNumbersOptedOutPaginator
default ListPhoneNumbersOptedOutIterable listPhoneNumbersOptedOutPaginator(Consumer<ListPhoneNumbersOptedOutRequest.Builder> listPhoneNumbersOptedOutRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException This is a variant of
listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
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.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client .listPhoneNumbersOptedOutPaginator(request); for (software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
operation.
This is a convenience which creates an instance of the
ListPhoneNumbersOptedOutRequest.Builder
avoiding the need to create one manually viaListPhoneNumbersOptedOutRequest.builder()
- Parameters:
listPhoneNumbersOptedOutRequest
- AConsumer
that will call methods onListPhoneNumbersOptedOutRequest.Builder
to create a request. The input for theListPhoneNumbersOptedOut
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlatformApplications
default ListPlatformApplicationsResponse listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for
ListPlatformApplications
are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you callListPlatformApplications
using the NextToken string received from the previous call. When there are no more records to return,NextToken
will be null. For more information, see Using Amazon SNS Mobile Push Notifications.This action is throttled at 15 transactions per second (TPS).
- Parameters:
listPlatformApplicationsRequest
- Input forListPlatformApplications
action.- Returns:
- Result of the ListPlatformApplications operation returned by the service.
- See Also:
-
listPlatformApplications
default ListPlatformApplicationsResponse listPlatformApplications(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for
ListPlatformApplications
are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you callListPlatformApplications
using the NextToken string received from the previous call. When there are no more records to return,NextToken
will be null. For more information, see Using Amazon SNS Mobile Push Notifications.This action is throttled at 15 transactions per second (TPS).
This is a convenience which creates an instance of the
ListPlatformApplicationsRequest.Builder
avoiding the need to create one manually viaListPlatformApplicationsRequest.builder()
- Parameters:
listPlatformApplicationsRequest
- AConsumer
that will call methods onListPlatformApplicationsRequest.Builder
to create a request. Input forListPlatformApplications
action.- Returns:
- Result of the ListPlatformApplications operation returned by the service.
- See Also:
-
listPlatformApplications
default ListPlatformApplicationsResponse listPlatformApplications() throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsExceptionLists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for
ListPlatformApplications
are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you callListPlatformApplications
using the NextToken string received from the previous call. When there are no more records to return,NextToken
will be null. For more information, see Using Amazon SNS Mobile Push Notifications.This action is throttled at 15 transactions per second (TPS).
- Returns:
- Result of the ListPlatformApplications operation returned by the service.
- See Also:
-
listPlatformApplicationsPaginator
default ListPlatformApplicationsIterable listPlatformApplicationsPaginator() throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsExceptionThis is a variant of
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
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.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client .listPlatformApplicationsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlatformApplicationsPaginator
default ListPlatformApplicationsIterable listPlatformApplicationsPaginator(ListPlatformApplicationsRequest listPlatformApplicationsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException This is a variant of
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
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.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client .listPlatformApplicationsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.- Parameters:
listPlatformApplicationsRequest
- Input forListPlatformApplications
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlatformApplicationsPaginator
default ListPlatformApplicationsIterable listPlatformApplicationsPaginator(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException This is a variant of
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
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.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client .listPlatformApplicationsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest)
operation.
This is a convenience which creates an instance of the
ListPlatformApplicationsRequest.Builder
avoiding the need to create one manually viaListPlatformApplicationsRequest.builder()
- Parameters:
listPlatformApplicationsRequest
- AConsumer
that will call methods onListPlatformApplicationsRequest.Builder
to create a request. Input forListPlatformApplications
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSMSSandboxPhoneNumbers
default ListSmsSandboxPhoneNumbersResponse listSMSSandboxPhoneNumbers(ListSmsSandboxPhoneNumbersRequest listSmsSandboxPhoneNumbersRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, ResourceNotFoundException, ThrottledException, AwsServiceException, SdkClientException, SnsException Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
- Parameters:
listSmsSandboxPhoneNumbersRequest
-- Returns:
- Result of the ListSMSSandboxPhoneNumbers operation returned by the service.
- See Also:
-
listSMSSandboxPhoneNumbers
default ListSmsSandboxPhoneNumbersResponse listSMSSandboxPhoneNumbers(Consumer<ListSmsSandboxPhoneNumbersRequest.Builder> listSmsSandboxPhoneNumbersRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, ResourceNotFoundException, ThrottledException, AwsServiceException, SdkClientException, SnsException Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
This is a convenience which creates an instance of the
ListSmsSandboxPhoneNumbersRequest.Builder
avoiding the need to create one manually viaListSmsSandboxPhoneNumbersRequest.builder()
- Parameters:
listSmsSandboxPhoneNumbersRequest
- AConsumer
that will call methods onListSmsSandboxPhoneNumbersRequest.Builder
to create a request.- Returns:
- Result of the ListSMSSandboxPhoneNumbers operation returned by the service.
- See Also:
-
listSMSSandboxPhoneNumbersPaginator
default ListSMSSandboxPhoneNumbersIterable listSMSSandboxPhoneNumbersPaginator(ListSmsSandboxPhoneNumbersRequest listSmsSandboxPhoneNumbersRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, ResourceNotFoundException, ThrottledException, AwsServiceException, SdkClientException, SnsException This is a variant of
listSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest)
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.sns.paginators.ListSMSSandboxPhoneNumbersIterable responses = client.listSMSSandboxPhoneNumbersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersIterable responses = client .listSMSSandboxPhoneNumbersPaginator(request); for (software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersIterable responses = client.listSMSSandboxPhoneNumbersPaginator(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
listSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest)
operation.- Parameters:
listSmsSandboxPhoneNumbersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSMSSandboxPhoneNumbersPaginator
default ListSMSSandboxPhoneNumbersIterable listSMSSandboxPhoneNumbersPaginator(Consumer<ListSmsSandboxPhoneNumbersRequest.Builder> listSmsSandboxPhoneNumbersRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, ResourceNotFoundException, ThrottledException, AwsServiceException, SdkClientException, SnsException This is a variant of
listSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest)
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.sns.paginators.ListSMSSandboxPhoneNumbersIterable responses = client.listSMSSandboxPhoneNumbersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersIterable responses = client .listSMSSandboxPhoneNumbersPaginator(request); for (software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersIterable responses = client.listSMSSandboxPhoneNumbersPaginator(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
listSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest)
operation.
This is a convenience which creates an instance of the
ListSmsSandboxPhoneNumbersRequest.Builder
avoiding the need to create one manually viaListSmsSandboxPhoneNumbersRequest.builder()
- Parameters:
listSmsSandboxPhoneNumbersRequest
- AConsumer
that will call methods onListSmsSandboxPhoneNumbersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubscriptions
default ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a
NextToken
is also returned. Use theNextToken
parameter in a newListSubscriptions
call to get further results.This action is throttled at 30 transactions per second (TPS).
- Parameters:
listSubscriptionsRequest
- Input for ListSubscriptions action.- Returns:
- Result of the ListSubscriptions operation returned by the service.
- See Also:
-
listSubscriptions
default ListSubscriptionsResponse listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a
NextToken
is also returned. Use theNextToken
parameter in a newListSubscriptions
call to get further results.This action is throttled at 30 transactions per second (TPS).
This is a convenience which creates an instance of the
ListSubscriptionsRequest.Builder
avoiding the need to create one manually viaListSubscriptionsRequest.builder()
- Parameters:
listSubscriptionsRequest
- AConsumer
that will call methods onListSubscriptionsRequest.Builder
to create a request. Input for ListSubscriptions action.- Returns:
- Result of the ListSubscriptions operation returned by the service.
- See Also:
-
listSubscriptions
default ListSubscriptionsResponse listSubscriptions() throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsExceptionReturns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a
NextToken
is also returned. Use theNextToken
parameter in a newListSubscriptions
call to get further results.This action is throttled at 30 transactions per second (TPS).
- Returns:
- Result of the ListSubscriptions operation returned by the service.
- See Also:
-
listSubscriptionsPaginator
default ListSubscriptionsIterable listSubscriptionsPaginator() throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsExceptionThis is a variant of
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
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.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client .listSubscriptionsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubscriptionsPaginator
default ListSubscriptionsIterable listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException This is a variant of
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
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.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client .listSubscriptionsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
operation.- Parameters:
listSubscriptionsRequest
- Input for ListSubscriptions action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubscriptionsPaginator
default ListSubscriptionsIterable listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException This is a variant of
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
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.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client .listSubscriptionsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
ListSubscriptionsRequest.Builder
avoiding the need to create one manually viaListSubscriptionsRequest.builder()
- Parameters:
listSubscriptionsRequest
- AConsumer
that will call methods onListSubscriptionsRequest.Builder
to create a request. Input for ListSubscriptions action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubscriptionsByTopic
default ListSubscriptionsByTopicResponse listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a
NextToken
is also returned. Use theNextToken
parameter in a newListSubscriptionsByTopic
call to get further results.This action is throttled at 30 transactions per second (TPS).
- Parameters:
listSubscriptionsByTopicRequest
- Input for ListSubscriptionsByTopic action.- Returns:
- Result of the ListSubscriptionsByTopic operation returned by the service.
- See Also:
-
listSubscriptionsByTopic
default ListSubscriptionsByTopicResponse listSubscriptionsByTopic(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a
NextToken
is also returned. Use theNextToken
parameter in a newListSubscriptionsByTopic
call to get further results.This action is throttled at 30 transactions per second (TPS).
This is a convenience which creates an instance of the
ListSubscriptionsByTopicRequest.Builder
avoiding the need to create one manually viaListSubscriptionsByTopicRequest.builder()
- Parameters:
listSubscriptionsByTopicRequest
- AConsumer
that will call methods onListSubscriptionsByTopicRequest.Builder
to create a request. Input for ListSubscriptionsByTopic action.- Returns:
- Result of the ListSubscriptionsByTopic operation returned by the service.
- See Also:
-
listSubscriptionsByTopicPaginator
default ListSubscriptionsByTopicIterable listSubscriptionsByTopicPaginator(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException This is a variant of
listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
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.sns.paginators.ListSubscriptionsByTopicIterable responses = client.listSubscriptionsByTopicPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicIterable responses = client .listSubscriptionsByTopicPaginator(request); for (software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicIterable responses = client.listSubscriptionsByTopicPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
operation.- Parameters:
listSubscriptionsByTopicRequest
- Input for ListSubscriptionsByTopic action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSubscriptionsByTopicPaginator
default ListSubscriptionsByTopicIterable listSubscriptionsByTopicPaginator(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException This is a variant of
listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
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.sns.paginators.ListSubscriptionsByTopicIterable responses = client.listSubscriptionsByTopicPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicIterable responses = client .listSubscriptionsByTopicPaginator(request); for (software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicIterable responses = client.listSubscriptionsByTopicPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest)
operation.
This is a convenience which creates an instance of the
ListSubscriptionsByTopicRequest.Builder
avoiding the need to create one manually viaListSubscriptionsByTopicRequest.builder()
- Parameters:
listSubscriptionsByTopicRequest
- AConsumer
that will call methods onListSubscriptionsByTopicRequest.Builder
to create a request. Input for ListSubscriptionsByTopic action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, TagPolicyException, InvalidParameterException, AuthorizationErrorException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, TagPolicyException, InvalidParameterException, AuthorizationErrorException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
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:
-
listTopics
default ListTopicsResponse listTopics(ListTopicsRequest listTopicsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a
NextToken
is also returned. Use theNextToken
parameter in a newListTopics
call to get further results.This action is throttled at 30 transactions per second (TPS).
- Parameters:
listTopicsRequest
-- Returns:
- Result of the ListTopics operation returned by the service.
- See Also:
-
listTopics
default ListTopicsResponse listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a
NextToken
is also returned. Use theNextToken
parameter in a newListTopics
call to get further results.This action is throttled at 30 transactions per second (TPS).
This is a convenience which creates an instance of the
ListTopicsRequest.Builder
avoiding the need to create one manually viaListTopicsRequest.builder()
- Parameters:
listTopicsRequest
- AConsumer
that will call methods onListTopicsRequest.Builder
to create a request.- Returns:
- Result of the ListTopics operation returned by the service.
- See Also:
-
listTopics
default ListTopicsResponse listTopics() throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsExceptionReturns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a
NextToken
is also returned. Use theNextToken
parameter in a newListTopics
call to get further results.This action is throttled at 30 transactions per second (TPS).
- Returns:
- Result of the ListTopics operation returned by the service.
- See Also:
-
listTopicsPaginator
default ListTopicsIterable listTopicsPaginator() throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsExceptionThis is a variant of
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
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.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListTopicsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTopicsPaginator
default ListTopicsIterable listTopicsPaginator(ListTopicsRequest listTopicsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException This is a variant of
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
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.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListTopicsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
operation.- Parameters:
listTopicsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTopicsPaginator
default ListTopicsIterable listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException This is a variant of
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
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.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); for (software.amazon.awssdk.services.sns.model.ListTopicsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest)
operation.
This is a convenience which creates an instance of the
ListTopicsRequest.Builder
avoiding the need to create one manually viaListTopicsRequest.builder()
- Parameters:
listTopicsRequest
- AConsumer
that will call methods onListTopicsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
optInPhoneNumber
default OptInPhoneNumberResponse optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
- Parameters:
optInPhoneNumberRequest
- Input for the OptInPhoneNumber action.- Returns:
- Result of the OptInPhoneNumber operation returned by the service.
- See Also:
-
optInPhoneNumber
default OptInPhoneNumberResponse optInPhoneNumber(Consumer<OptInPhoneNumberRequest.Builder> optInPhoneNumberRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SnsException Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
This is a convenience which creates an instance of the
OptInPhoneNumberRequest.Builder
avoiding the need to create one manually viaOptInPhoneNumberRequest.builder()
- Parameters:
optInPhoneNumberRequest
- AConsumer
that will call methods onOptInPhoneNumberRequest.Builder
to create a request. Input for the OptInPhoneNumber action.- Returns:
- Result of the OptInPhoneNumber operation returned by the service.
- See Also:
-
publish
default PublishResponse publish(PublishRequest publishRequest) throws InvalidParameterException, InvalidParameterValueException, InternalErrorException, NotFoundException, EndpointDisabledException, PlatformApplicationDisabledException, AuthorizationErrorException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, KmsAccessDeniedException, InvalidSecurityException, ValidationException, AwsServiceException, SdkClientException, SnsException Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the
TargetArn
).If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a
messageId
is returned, the message is saved and Amazon SNS immediately delivers it to subscribers.To use the
Publish
action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with theCreatePlatformEndpoint
action.For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
You can publish messages only to topics and endpoints in the same Amazon Web Services Region.
- Parameters:
publishRequest
- Input for Publish action.- Returns:
- Result of the Publish operation returned by the service.
- See Also:
-
publish
default PublishResponse publish(Consumer<PublishRequest.Builder> publishRequest) throws InvalidParameterException, InvalidParameterValueException, InternalErrorException, NotFoundException, EndpointDisabledException, PlatformApplicationDisabledException, AuthorizationErrorException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, KmsAccessDeniedException, InvalidSecurityException, ValidationException, AwsServiceException, SdkClientException, SnsException Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the
TargetArn
).If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a
messageId
is returned, the message is saved and Amazon SNS immediately delivers it to subscribers.To use the
Publish
action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with theCreatePlatformEndpoint
action.For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
You can publish messages only to topics and endpoints in the same Amazon Web Services Region.
This is a convenience which creates an instance of the
PublishRequest.Builder
avoiding the need to create one manually viaPublishRequest.builder()
- Parameters:
publishRequest
- AConsumer
that will call methods onPublishRequest.Builder
to create a request. Input for Publish action.- Returns:
- Result of the Publish operation returned by the service.
- See Also:
-
publishBatch
default PublishBatchResponse publishBatch(PublishBatchRequest publishBatchRequest) throws InvalidParameterException, InvalidParameterValueException, InternalErrorException, NotFoundException, EndpointDisabledException, PlatformApplicationDisabledException, AuthorizationErrorException, BatchEntryIdsNotDistinctException, BatchRequestTooLongException, EmptyBatchRequestException, InvalidBatchEntryIdException, TooManyEntriesInBatchRequestException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, KmsAccessDeniedException, InvalidSecurityException, ValidationException, AwsServiceException, SdkClientException, SnsException Publishes up to ten messages to the specified topic. This is a batch version of
Publish
. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of
200
.The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
Some actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:&AttributeName.1=first
&AttributeName.2=second
If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.
When a
messageId
is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.- Parameters:
publishBatchRequest
-- Returns:
- Result of the PublishBatch operation returned by the service.
- See Also:
-
publishBatch
default PublishBatchResponse publishBatch(Consumer<PublishBatchRequest.Builder> publishBatchRequest) throws InvalidParameterException, InvalidParameterValueException, InternalErrorException, NotFoundException, EndpointDisabledException, PlatformApplicationDisabledException, AuthorizationErrorException, BatchEntryIdsNotDistinctException, BatchRequestTooLongException, EmptyBatchRequestException, InvalidBatchEntryIdException, TooManyEntriesInBatchRequestException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, KmsAccessDeniedException, InvalidSecurityException, ValidationException, AwsServiceException, SdkClientException, SnsException Publishes up to ten messages to the specified topic. This is a batch version of
Publish
. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of
200
.The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
Some actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:&AttributeName.1=first
&AttributeName.2=second
If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.
When a
messageId
is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.
This is a convenience which creates an instance of the
PublishBatchRequest.Builder
avoiding the need to create one manually viaPublishBatchRequest.builder()
- Parameters:
publishBatchRequest
- AConsumer
that will call methods onPublishBatchRequest.Builder
to create a request.- Returns:
- Result of the PublishBatch operation returned by the service.
- See Also:
-
putDataProtectionPolicy
default PutDataProtectionPolicyResponse putDataProtectionPolicy(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
- Parameters:
putDataProtectionPolicyRequest
-- Returns:
- Result of the PutDataProtectionPolicy operation returned by the service.
- See Also:
-
putDataProtectionPolicy
default PutDataProtectionPolicyResponse putDataProtectionPolicy(Consumer<PutDataProtectionPolicyRequest.Builder> putDataProtectionPolicyRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
This is a convenience which creates an instance of the
PutDataProtectionPolicyRequest.Builder
avoiding the need to create one manually viaPutDataProtectionPolicyRequest.builder()
- Parameters:
putDataProtectionPolicyRequest
- AConsumer
that will call methods onPutDataProtectionPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutDataProtectionPolicy operation returned by the service.
- See Also:
-
removePermission
default RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Removes a statement from a topic's access control policy.
To remove the ability to change topic permissions, you must deny permissions to the
AddPermission
,RemovePermission
, andSetTopicAttributes
actions in your IAM policy.- Parameters:
removePermissionRequest
- Input for RemovePermission action.- Returns:
- Result of the RemovePermission operation returned by the service.
- See Also:
-
removePermission
default RemovePermissionResponse removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Removes a statement from a topic's access control policy.
To remove the ability to change topic permissions, you must deny permissions to the
AddPermission
,RemovePermission
, andSetTopicAttributes
actions in your IAM policy.
This is a convenience which creates an instance of the
RemovePermissionRequest.Builder
avoiding the need to create one manually viaRemovePermissionRequest.builder()
- Parameters:
removePermissionRequest
- AConsumer
that will call methods onRemovePermissionRequest.Builder
to create a request. Input for RemovePermission action.- Returns:
- Result of the RemovePermission operation returned by the service.
- See Also:
-
setEndpointAttributes
default SetEndpointAttributesResponse setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
- Parameters:
setEndpointAttributesRequest
- Input forSetEndpointAttributes
action.- Returns:
- Result of the SetEndpointAttributes operation returned by the service.
- See Also:
-
setEndpointAttributes
default SetEndpointAttributesResponse setEndpointAttributes(Consumer<SetEndpointAttributesRequest.Builder> setEndpointAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
This is a convenience which creates an instance of the
SetEndpointAttributesRequest.Builder
avoiding the need to create one manually viaSetEndpointAttributesRequest.builder()
- Parameters:
setEndpointAttributesRequest
- AConsumer
that will call methods onSetEndpointAttributesRequest.Builder
to create a request. Input forSetEndpointAttributes
action.- Returns:
- Result of the SetEndpointAttributes operation returned by the service.
- See Also:
-
setPlatformApplicationAttributes
default SetPlatformApplicationAttributesResponse setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
- Parameters:
setPlatformApplicationAttributesRequest
- Input forSetPlatformApplicationAttributes
action.- Returns:
- Result of the SetPlatformApplicationAttributes operation returned by the service.
- See Also:
-
setPlatformApplicationAttributes
default SetPlatformApplicationAttributesResponse setPlatformApplicationAttributes(Consumer<SetPlatformApplicationAttributesRequest.Builder> setPlatformApplicationAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SnsException Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
This is a convenience which creates an instance of the
SetPlatformApplicationAttributesRequest.Builder
avoiding the need to create one manually viaSetPlatformApplicationAttributesRequest.builder()
- Parameters:
setPlatformApplicationAttributesRequest
- AConsumer
that will call methods onSetPlatformApplicationAttributesRequest.Builder
to create a request. Input forSetPlatformApplicationAttributes
action.- Returns:
- Result of the SetPlatformApplicationAttributes operation returned by the service.
- See Also:
-
setSMSAttributes
default SetSmsAttributesResponse setSMSAttributes(SetSmsAttributesRequest setSmsAttributesRequest) throws InvalidParameterException, ThrottledException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the
Publish
action with theMessageAttributes.entry.N
parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.To use this operation, you must grant the Amazon SNS service principal (
sns.amazonaws.com
) permission to perform thes3:ListBucket
action.- Parameters:
setSmsAttributesRequest
- The input for the SetSMSAttributes action.- Returns:
- Result of the SetSMSAttributes operation returned by the service.
- See Also:
-
setSMSAttributes
default SetSmsAttributesResponse setSMSAttributes(Consumer<SetSmsAttributesRequest.Builder> setSmsAttributesRequest) throws InvalidParameterException, ThrottledException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the
Publish
action with theMessageAttributes.entry.N
parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.To use this operation, you must grant the Amazon SNS service principal (
sns.amazonaws.com
) permission to perform thes3:ListBucket
action.
This is a convenience which creates an instance of the
SetSmsAttributesRequest.Builder
avoiding the need to create one manually viaSetSmsAttributesRequest.builder()
- Parameters:
setSmsAttributesRequest
- AConsumer
that will call methods onSetSmsAttributesRequest.Builder
to create a request. The input for the SetSMSAttributes action.- Returns:
- Result of the SetSMSAttributes operation returned by the service.
- See Also:
-
setSubscriptionAttributes
default SetSubscriptionAttributesResponse setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws InvalidParameterException, FilterPolicyLimitExceededException, ReplayLimitExceededException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Allows a subscription owner to set an attribute of the subscription to a new value.
- Parameters:
setSubscriptionAttributesRequest
- Input for SetSubscriptionAttributes action.- Returns:
- Result of the SetSubscriptionAttributes operation returned by the service.
- See Also:
-
setSubscriptionAttributes
default SetSubscriptionAttributesResponse setSubscriptionAttributes(Consumer<SetSubscriptionAttributesRequest.Builder> setSubscriptionAttributesRequest) throws InvalidParameterException, FilterPolicyLimitExceededException, ReplayLimitExceededException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException Allows a subscription owner to set an attribute of the subscription to a new value.
This is a convenience which creates an instance of the
SetSubscriptionAttributesRequest.Builder
avoiding the need to create one manually viaSetSubscriptionAttributesRequest.builder()
- Parameters:
setSubscriptionAttributesRequest
- AConsumer
that will call methods onSetSubscriptionAttributesRequest.Builder
to create a request. Input for SetSubscriptionAttributes action.- Returns:
- Result of the SetSubscriptionAttributes operation returned by the service.
- See Also:
-
setTopicAttributes
default SetTopicAttributesResponse setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Allows a topic owner to set an attribute of the topic to a new value.
To remove the ability to change topic permissions, you must deny permissions to the
AddPermission
,RemovePermission
, andSetTopicAttributes
actions in your IAM policy.- Parameters:
setTopicAttributesRequest
- Input for SetTopicAttributes action.- Returns:
- Result of the SetTopicAttributes operation returned by the service.
- See Also:
-
setTopicAttributes
default SetTopicAttributesResponse setTopicAttributes(Consumer<SetTopicAttributesRequest.Builder> setTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Allows a topic owner to set an attribute of the topic to a new value.
To remove the ability to change topic permissions, you must deny permissions to the
AddPermission
,RemovePermission
, andSetTopicAttributes
actions in your IAM policy.
This is a convenience which creates an instance of the
SetTopicAttributesRequest.Builder
avoiding the need to create one manually viaSetTopicAttributesRequest.builder()
- Parameters:
setTopicAttributesRequest
- AConsumer
that will call methods onSetTopicAttributesRequest.Builder
to create a request. Input for SetTopicAttributes action.- Returns:
- Result of the SetTopicAttributes operation returned by the service.
- See Also:
-
subscribe
default SubscribeResponse subscribe(SubscribeRequest subscribeRequest) throws SubscriptionLimitExceededException, FilterPolicyLimitExceededException, ReplayLimitExceededException, InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the
ConfirmSubscription
action to confirm the subscription.You call the
ConfirmSubscription
action with the token from the subscription response. Confirmation tokens are valid for two days.This action is throttled at 100 transactions per second (TPS).
- Parameters:
subscribeRequest
- Input for Subscribe action.- Returns:
- Result of the Subscribe operation returned by the service.
- See Also:
-
subscribe
default SubscribeResponse subscribe(Consumer<SubscribeRequest.Builder> subscribeRequest) throws SubscriptionLimitExceededException, FilterPolicyLimitExceededException, ReplayLimitExceededException, InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the
ConfirmSubscription
action to confirm the subscription.You call the
ConfirmSubscription
action with the token from the subscription response. Confirmation tokens are valid for two days.This action is throttled at 100 transactions per second (TPS).
This is a convenience which creates an instance of the
SubscribeRequest.Builder
avoiding the need to create one manually viaSubscribeRequest.builder()
- Parameters:
subscribeRequest
- AConsumer
that will call methods onSubscribeRequest.Builder
to create a request. Input for Subscribe action.- Returns:
- Result of the Subscribe operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, TagLimitExceededException, StaleTagException, TagPolicyException, InvalidParameterException, AuthorizationErrorException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
-
Adding more than 50 tags to a topic isn't recommended.
-
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
-
Tags are case-sensitive.
-
A new tag with a key identical to that of an existing tag overwrites the existing tag.
-
Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, TagLimitExceededException, StaleTagException, TagPolicyException, InvalidParameterException, AuthorizationErrorException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
-
Adding more than 50 tags to a topic isn't recommended.
-
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
-
Tags are case-sensitive.
-
A new tag with a key identical to that of an existing tag overwrites the existing tag.
-
Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
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:
-
-
unsubscribe
default UnsubscribeResponse unsubscribe(UnsubscribeRequest unsubscribeRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the
Unsubscribe
call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if theUnsubscribe
request was unintended.Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.
This action is throttled at 100 transactions per second (TPS).
- Parameters:
unsubscribeRequest
- Input for Unsubscribe action.- Returns:
- Result of the Unsubscribe operation returned by the service.
- See Also:
-
unsubscribe
default UnsubscribeResponse unsubscribe(Consumer<UnsubscribeRequest.Builder> unsubscribeRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, InvalidSecurityException, AwsServiceException, SdkClientException, SnsException Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the
Unsubscribe
call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if theUnsubscribe
request was unintended.Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.
This action is throttled at 100 transactions per second (TPS).
This is a convenience which creates an instance of the
UnsubscribeRequest.Builder
avoiding the need to create one manually viaUnsubscribeRequest.builder()
- Parameters:
unsubscribeRequest
- AConsumer
that will call methods onUnsubscribeRequest.Builder
to create a request. Input for Unsubscribe action.- Returns:
- Result of the Unsubscribe operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, TagLimitExceededException, StaleTagException, TagPolicyException, InvalidParameterException, AuthorizationErrorException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS 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 ResourceNotFoundException, TagLimitExceededException, StaleTagException, TagPolicyException, InvalidParameterException, AuthorizationErrorException, ConcurrentAccessException, AwsServiceException, SdkClientException, SnsException Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS 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:
-
verifySMSSandboxPhoneNumber
default VerifySmsSandboxPhoneNumberResponse verifySMSSandboxPhoneNumber(VerifySmsSandboxPhoneNumberRequest verifySmsSandboxPhoneNumberRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, ResourceNotFoundException, VerificationException, ThrottledException, AwsServiceException, SdkClientException, SnsException Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
- Parameters:
verifySmsSandboxPhoneNumberRequest
-- Returns:
- Result of the VerifySMSSandboxPhoneNumber operation returned by the service.
- See Also:
-
verifySMSSandboxPhoneNumber
default VerifySmsSandboxPhoneNumberResponse verifySMSSandboxPhoneNumber(Consumer<VerifySmsSandboxPhoneNumberRequest.Builder> verifySmsSandboxPhoneNumberRequest) throws AuthorizationErrorException, InternalErrorException, InvalidParameterException, ResourceNotFoundException, VerificationException, ThrottledException, AwsServiceException, SdkClientException, SnsException Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
This is a convenience which creates an instance of the
VerifySmsSandboxPhoneNumberRequest.Builder
avoiding the need to create one manually viaVerifySmsSandboxPhoneNumberRequest.builder()
- Parameters:
verifySmsSandboxPhoneNumberRequest
- AConsumer
that will call methods onVerifySmsSandboxPhoneNumberRequest.Builder
to create a request.- Returns:
- Result of the VerifySMSSandboxPhoneNumber operation returned by the service.
- See Also:
-
create
Create aSnsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSnsClient
. -
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
-