@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SnsClient extends 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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
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.
|
default 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.
|
static SnsClientBuilder |
builder()
Create a builder that can be used to configure and create a
SnsClient . |
default CheckIfPhoneNumberIsOptedOutResponse |
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 CheckIfPhoneNumberIsOptedOutResponse |
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.
|
default ConfirmSubscriptionResponse |
confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier
Subscribe action. |
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
earlier
Subscribe action. |
static SnsClient |
create()
Create a
SnsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreatePlatformApplicationResponse |
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.
|
default CreatePlatformApplicationResponse |
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.
|
default CreateSmsSandboxPhoneNumberResponse |
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.
|
default CreateSmsSandboxPhoneNumberResponse |
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.
|
default DeletePlatformApplicationResponse |
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).
|
default DeletePlatformApplicationResponse |
deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
default DeleteSmsSandboxPhoneNumberResponse |
deleteSMSSandboxPhoneNumber(Consumer<DeleteSmsSandboxPhoneNumberRequest.Builder> deleteSmsSandboxPhoneNumberRequest)
Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
|
default DeleteSmsSandboxPhoneNumberResponse |
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 inline
DataProtectionPolicy document that is stored in the specified Amazon
SNS topic. |
default GetDataProtectionPolicyResponse |
getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest)
Retrieves the specified inline
DataProtectionPolicy 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.
|
default GetPlatformApplicationAttributesResponse |
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).
|
default GetPlatformApplicationAttributesResponse |
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 |
getSMSAttributes()
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.
|
default GetSmsSandboxAccountStatusResponse |
getSMSSandboxAccountStatus(Consumer<GetSmsSandboxAccountStatusRequest.Builder> getSmsSandboxAccountStatusRequest)
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services
Region.
|
default GetSmsSandboxAccountStatusResponse |
getSMSSandboxAccountStatus(GetSmsSandboxAccountStatusRequest getSmsSandboxAccountStatusRequest)
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services
Region.
|
default GetSubscriptionAttributesResponse |
getSubscriptionAttributes(Consumer<GetSubscriptionAttributesRequest.Builder> getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
|
default GetSubscriptionAttributesResponse |
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.
|
default ListEndpointsByPlatformApplicationResponse |
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.
|
default ListEndpointsByPlatformApplicationResponse |
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.
|
default ListEndpointsByPlatformApplicationIterable |
listEndpointsByPlatformApplicationPaginator(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.
|
default ListEndpointsByPlatformApplicationIterable |
listEndpointsByPlatformApplicationPaginator(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM
(Firebase Cloud Messaging) and APNS.
|
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)
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
|
default ListOriginationNumbersIterable |
listOriginationNumbersPaginator(ListOriginationNumbersRequest listOriginationNumbersRequest)
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
|
default ListPhoneNumbersOptedOutResponse |
listPhoneNumbersOptedOut()
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 |
listPhoneNumbersOptedOutPaginator()
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
default ListPhoneNumbersOptedOutIterable |
listPhoneNumbersOptedOutPaginator(Consumer<ListPhoneNumbersOptedOutRequest.Builder> listPhoneNumbersOptedOutRequest)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
default ListPhoneNumbersOptedOutIterable |
listPhoneNumbersOptedOutPaginator(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
default ListPlatformApplicationsResponse |
listPlatformApplications()
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 |
listPlatformApplicationsPaginator()
Lists the platform application objects for the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
default ListPlatformApplicationsIterable |
listPlatformApplicationsPaginator(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
default ListPlatformApplicationsIterable |
listPlatformApplicationsPaginator(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
default ListSmsSandboxPhoneNumbersResponse |
listSMSSandboxPhoneNumbers(Consumer<ListSmsSandboxPhoneNumbersRequest.Builder> listSmsSandboxPhoneNumbersRequest)
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS
sandbox.
|
default ListSmsSandboxPhoneNumbersResponse |
listSMSSandboxPhoneNumbers(ListSmsSandboxPhoneNumbersRequest listSmsSandboxPhoneNumbersRequest)
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS
sandbox.
|
default ListSMSSandboxPhoneNumbersIterable |
listSMSSandboxPhoneNumbersPaginator(Consumer<ListSmsSandboxPhoneNumbersRequest.Builder> listSmsSandboxPhoneNumbersRequest)
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS
sandbox.
|
default ListSMSSandboxPhoneNumbersIterable |
listSMSSandboxPhoneNumbersPaginator(ListSmsSandboxPhoneNumbersRequest listSmsSandboxPhoneNumbersRequest)
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS
sandbox.
|
default ListSubscriptionsResponse |
listSubscriptions()
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)
Returns a list of the subscriptions to a specific topic.
|
default ListSubscriptionsByTopicIterable |
listSubscriptionsByTopicPaginator(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic.
|
default ListSubscriptionsIterable |
listSubscriptionsPaginator()
Returns a list of the requester's subscriptions.
|
default ListSubscriptionsIterable |
listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
default ListSubscriptionsIterable |
listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
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 |
listTopics()
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 |
listTopicsPaginator()
Returns a list of the requester's topics.
|
default ListTopicsIterable |
listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
Returns a list of the requester's topics.
|
default ListTopicsIterable |
listTopicsPaginator(ListTopicsRequest listTopicsRequest)
Returns a list of the requester's topics.
|
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 the
TargetArn ). |
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 the
TargetArn ). |
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.
|
static ServiceMetadata |
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.
|
default SetPlatformApplicationAttributesResponse |
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).
|
default SetPlatformApplicationAttributesResponse |
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.
|
default SetSubscriptionAttributesResponse |
setSubscriptionAttributes(Consumer<SetSubscriptionAttributesRequest.Builder> setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the subscription to a new value.
|
default SetSubscriptionAttributesResponse |
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.
|
default VerifySmsSandboxPhoneNumberResponse |
verifySMSSandboxPhoneNumber(Consumer<VerifySmsSandboxPhoneNumberRequest.Builder> verifySmsSandboxPhoneNumberRequest)
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
|
default VerifySmsSandboxPhoneNumberResponse |
verifySMSSandboxPhoneNumber(VerifySmsSandboxPhoneNumberRequest verifySmsSandboxPhoneNumberRequest)
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.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
, and SetTopicAttributes
actions in your IAM policy.
addPermissionRequest
- InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and SetTopicAttributes
actions in your IAM policy.
This is a convenience which creates an instance of the AddPermissionRequest.Builder
avoiding the need to
create one manually via AddPermissionRequest.builder()
addPermissionRequest
- A Consumer
that will call methods on AddPermissionInput.Builder
to create a request.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
checkIfPhoneNumberIsOptedOutRequest
- The input for the CheckIfPhoneNumberIsOptedOut
action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CheckIfPhoneNumberIsOptedOutRequest.builder()
checkIfPhoneNumberIsOptedOutRequest
- A Consumer
that will call methods on CheckIfPhoneNumberIsOptedOutInput.Builder
to create a
request. The input for the CheckIfPhoneNumberIsOptedOut
action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConfirmSubscriptionResponse confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest) throws SubscriptionLimitExceededException, InvalidParameterException, NotFoundException, InternalErrorException, AuthorizationErrorException, FilterPolicyLimitExceededException, 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 the
AuthenticateOnUnsubscribe
flag is set to "true".
confirmSubscriptionRequest
- Input for ConfirmSubscription action.SubscriptionLimitExceededException
- Indicates that the customer already owns the maximum allowed number of subscriptions.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.NotFoundException
- Indicates that the requested resource does not exist.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add
more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConfirmSubscriptionResponse confirmSubscription(Consumer<ConfirmSubscriptionRequest.Builder> confirmSubscriptionRequest) throws SubscriptionLimitExceededException, InvalidParameterException, NotFoundException, InternalErrorException, AuthorizationErrorException, FilterPolicyLimitExceededException, 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 the
AuthenticateOnUnsubscribe
flag is set to "true".
This is a convenience which creates an instance of the ConfirmSubscriptionRequest.Builder
avoiding the
need to create one manually via ConfirmSubscriptionRequest.builder()
confirmSubscriptionRequest
- A Consumer
that will call methods on ConfirmSubscriptionInput.Builder
to create a request.
Input for ConfirmSubscription action.SubscriptionLimitExceededException
- Indicates that the customer already owns the maximum allowed number of subscriptions.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.NotFoundException
- Indicates that the requested resource does not exist.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add
more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and PlatformCredential
attributes when using the
CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM
, PlatformPrincipal
is client id
and
PlatformCredential
is client secret
.
For Baidu
, PlatformPrincipal
is API key
and
PlatformCredential
is secret key
.
For APNS
and APNS_SANDBOX
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS
and APNS_SANDBOX
using token credentials, PlatformPrincipal
is
signing key ID
and PlatformCredential
is signing key
.
For GCM
(Firebase Cloud Messaging), there is no PlatformPrincipal
and the
PlatformCredential
is API key
.
For MPNS
, PlatformPrincipal
is TLS certificate
and
PlatformCredential
is private key
.
For WNS
, PlatformPrincipal
is Package Security Identifier
and
PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the
CreatePlatformEndpoint
action.
createPlatformApplicationRequest
- Input for CreatePlatformApplication action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
and PlatformCredential
attributes when using the
CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM
, PlatformPrincipal
is client id
and
PlatformCredential
is client secret
.
For Baidu
, PlatformPrincipal
is API key
and
PlatformCredential
is secret key
.
For APNS
and APNS_SANDBOX
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS
and APNS_SANDBOX
using token credentials, PlatformPrincipal
is
signing key ID
and PlatformCredential
is signing key
.
For GCM
(Firebase Cloud Messaging), there is no PlatformPrincipal
and the
PlatformCredential
is API key
.
For MPNS
, PlatformPrincipal
is TLS certificate
and
PlatformCredential
is private key
.
For WNS
, PlatformPrincipal
is Package Security Identifier
and
PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the
CreatePlatformEndpoint
action.
This is a convenience which creates an instance of the CreatePlatformApplicationRequest.Builder
avoiding
the need to create one manually via CreatePlatformApplicationRequest.builder()
createPlatformApplicationRequest
- A Consumer
that will call methods on CreatePlatformApplicationInput.Builder
to create a
request. Input for CreatePlatformApplication action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
PlatformApplicationArn
that is returned from CreatePlatformApplication
. You can use the
returned EndpointArn
to send a message to a mobile app or by the Subscribe
action for
subscription to a topic. The CreatePlatformEndpoint
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.
createPlatformEndpointRequest
- Input for CreatePlatformEndpoint action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the
PlatformApplicationArn
that is returned from CreatePlatformApplication
. You can use the
returned EndpointArn
to send a message to a mobile app or by the Subscribe
action for
subscription to a topic. The CreatePlatformEndpoint
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 via CreatePlatformEndpointRequest.builder()
createPlatformEndpointRequest
- A Consumer
that will call methods on CreatePlatformEndpointInput.Builder
to create a
request. Input for CreatePlatformEndpoint action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createSmsSandboxPhoneNumberRequest
- AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.OptedOutException
- Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web
Services account. You can't send SMS messages to phone numbers that opt out.UserErrorException
- Indicates that a request parameter does not comply with the associated constraints.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateSmsSandboxPhoneNumberRequest.builder()
createSmsSandboxPhoneNumberRequest
- A Consumer
that will call methods on CreateSMSSandboxPhoneNumberInput.Builder
to create a
request.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.OptedOutException
- Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web
Services account. You can't send SMS messages to phone numbers that opt out.UserErrorException
- Indicates that a request parameter does not comply with the associated constraints.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createTopicRequest
- Input for CreateTopic action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.TopicLimitExceededException
- Indicates that the customer already owns the maximum allowed number of topics.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateTopicRequest.builder()
createTopicRequest
- A Consumer
that will call methods on CreateTopicInput.Builder
to create a request. Input
for CreateTopic action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.TopicLimitExceededException
- Indicates that the customer already owns the maximum allowed number of topics.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteEndpointRequest
- Input for DeleteEndpoint action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteEndpointRequest.builder()
deleteEndpointRequest
- A Consumer
that will call methods on DeleteEndpointInput.Builder
to create a request.
Input for DeleteEndpoint action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deletePlatformApplicationRequest
- Input for DeletePlatformApplication action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeletePlatformApplicationRequest.builder()
deletePlatformApplicationRequest
- A Consumer
that will call methods on DeletePlatformApplicationInput.Builder
to create a
request. Input for DeletePlatformApplication action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteSmsSandboxPhoneNumberRequest
- AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.UserErrorException
- Indicates that a request parameter does not comply with the associated constraints.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteSmsSandboxPhoneNumberRequest.builder()
deleteSmsSandboxPhoneNumberRequest
- A Consumer
that will call methods on DeleteSMSSandboxPhoneNumberInput.Builder
to create a
request.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.UserErrorException
- Indicates that a request parameter does not comply with the associated constraints.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTopicResponse deleteTopic(DeleteTopicRequest deleteTopicRequest) throws InvalidParameterException, 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.
deleteTopicRequest
- InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTopicResponse deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest) throws InvalidParameterException, 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 via DeleteTopicRequest.builder()
deleteTopicRequest
- A Consumer
that will call methods on DeleteTopicInput.Builder
to create a request.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getDataProtectionPolicyRequest
- InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetDataProtectionPolicyRequest.builder()
getDataProtectionPolicyRequest
- A Consumer
that will call methods on GetDataProtectionPolicyInput.Builder
to create a
request.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getEndpointAttributesRequest
- Input for GetEndpointAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetEndpointAttributesRequest.builder()
getEndpointAttributesRequest
- A Consumer
that will call methods on GetEndpointAttributesInput.Builder
to create a
request. Input for GetEndpointAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getPlatformApplicationAttributesRequest
- Input for GetPlatformApplicationAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetPlatformApplicationAttributesRequest.builder()
getPlatformApplicationAttributesRequest
- A Consumer
that will call methods on GetPlatformApplicationAttributesInput.Builder
to
create a request. Input for GetPlatformApplicationAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSmsAttributesResponse getSMSAttributes() 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.
ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getSMSAttributes(GetSmsAttributesRequest)
,
AWS API
Documentationdefault 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.
getSmsAttributesRequest
- The input for the GetSMSAttributes
request.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetSmsAttributesRequest.builder()
getSmsAttributesRequest
- A Consumer
that will call methods on GetSMSAttributesInput.Builder
to create a request.
The input for the GetSMSAttributes
request.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getSmsSandboxAccountStatusRequest
- AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetSmsSandboxAccountStatusRequest.builder()
getSmsSandboxAccountStatusRequest
- A Consumer
that will call methods on GetSMSSandboxAccountStatusInput.Builder
to create a
request.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSubscriptionAttributesResponse getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException
Returns all of the properties of a subscription.
getSubscriptionAttributesRequest
- Input for GetSubscriptionAttributes.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetSubscriptionAttributesRequest.builder()
getSubscriptionAttributesRequest
- A Consumer
that will call methods on GetSubscriptionAttributesInput.Builder
to create a
request. Input for GetSubscriptionAttributes.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getTopicAttributesRequest
- Input for GetTopicAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetTopicAttributesRequest.builder()
getTopicAttributesRequest
- A Consumer
that will call methods on GetTopicAttributesInput.Builder
to create a request.
Input for GetTopicAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 call
ListEndpointsByPlatformApplication
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).
listEndpointsByPlatformApplicationRequest
- Input for ListEndpointsByPlatformApplication action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 call
ListEndpointsByPlatformApplication
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 via ListEndpointsByPlatformApplicationRequest.builder()
listEndpointsByPlatformApplicationRequest
- A Consumer
that will call methods on ListEndpointsByPlatformApplicationInput.Builder
to
create a request. Input for ListEndpointsByPlatformApplication action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEndpointsByPlatformApplicationIterable listEndpointsByPlatformApplicationPaginator(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 call
ListEndpointsByPlatformApplication
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 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 Stream
software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationIterable responses = client.listEndpointsByPlatformApplicationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
listEndpointsByPlatformApplicationRequest
- Input for ListEndpointsByPlatformApplication action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEndpointsByPlatformApplicationIterable listEndpointsByPlatformApplicationPaginator(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 call
ListEndpointsByPlatformApplication
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 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 Stream
software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationIterable responses = client.listEndpointsByPlatformApplicationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via ListEndpointsByPlatformApplicationRequest.builder()
listEndpointsByPlatformApplicationRequest
- A Consumer
that will call methods on ListEndpointsByPlatformApplicationInput.Builder
to
create a request. Input for ListEndpointsByPlatformApplication action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listOriginationNumbersRequest
- InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ValidationException
- Indicates that a parameter in the request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListOriginationNumbersRequest.builder()
listOriginationNumbersRequest
- A Consumer
that will call methods on ListOriginationNumbersRequest.Builder
to create a
request.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ValidationException
- Indicates that a parameter in the request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOriginationNumbersIterable listOriginationNumbersPaginator(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.
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 Stream
software.amazon.awssdk.services.sns.paginators.ListOriginationNumbersIterable responses = client.listOriginationNumbersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
listOriginationNumbersRequest
- InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ValidationException
- Indicates that a parameter in the request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOriginationNumbersIterable listOriginationNumbersPaginator(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 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 Stream
software.amazon.awssdk.services.sns.paginators.ListOriginationNumbersIterable responses = client.listOriginationNumbersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via ListOriginationNumbersRequest.builder()
listOriginationNumbersRequest
- A Consumer
that will call methods on ListOriginationNumbersRequest.Builder
to create a
request.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ValidationException
- Indicates that a parameter in the request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPhoneNumbersOptedOutResponse listPhoneNumbersOptedOut() 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 a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there are no more records to return,
NextToken
will be null.
ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest)
,
AWS
API Documentationdefault 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 a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there are no more records to return,
NextToken
will be null.
listPhoneNumbersOptedOutRequest
- The input for the ListPhoneNumbersOptedOut
action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
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 via ListPhoneNumbersOptedOutRequest.builder()
listPhoneNumbersOptedOutRequest
- A Consumer
that will call methods on ListPhoneNumbersOptedOutInput.Builder
to create a
request. The input for the ListPhoneNumbersOptedOut
action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPhoneNumbersOptedOutIterable listPhoneNumbersOptedOutPaginator() 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 a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there are no more records to return,
NextToken
will be null.
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 Stream
software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPhoneNumbersOptedOutPaginator(ListPhoneNumbersOptedOutRequest)
,
AWS
API Documentationdefault ListPhoneNumbersOptedOutIterable listPhoneNumbersOptedOutPaginator(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 a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there are no more records to return,
NextToken
will be null.
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 Stream
software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
listPhoneNumbersOptedOutRequest
- The input for the ListPhoneNumbersOptedOut
action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPhoneNumbersOptedOutIterable listPhoneNumbersOptedOutPaginator(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 a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there are no more records to return,
NextToken
will be null.
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 Stream
software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via ListPhoneNumbersOptedOutRequest.builder()
listPhoneNumbersOptedOutRequest
- A Consumer
that will call methods on ListPhoneNumbersOptedOutInput.Builder
to create a
request. The input for the ListPhoneNumbersOptedOut
action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPlatformApplicationsResponse listPlatformApplications() 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 call ListPlatformApplications
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).
InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPlatformApplications(ListPlatformApplicationsRequest)
,
AWS
API Documentationdefault 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 call ListPlatformApplications
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).
listPlatformApplicationsRequest
- Input for ListPlatformApplications action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 call ListPlatformApplications
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 via ListPlatformApplicationsRequest.builder()
listPlatformApplicationsRequest
- A Consumer
that will call methods on ListPlatformApplicationsInput.Builder
to create a
request. Input for ListPlatformApplications action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPlatformApplicationsIterable listPlatformApplicationsPaginator() 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 call ListPlatformApplications
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 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 Stream
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPlatformApplicationsPaginator(ListPlatformApplicationsRequest)
,
AWS
API Documentationdefault ListPlatformApplicationsIterable listPlatformApplicationsPaginator(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 call ListPlatformApplications
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 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 Stream
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
listPlatformApplicationsRequest
- Input for ListPlatformApplications action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPlatformApplicationsIterable listPlatformApplicationsPaginator(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 call ListPlatformApplications
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 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 Stream
software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsIterable responses = client.listPlatformApplicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via ListPlatformApplicationsRequest.builder()
listPlatformApplicationsRequest
- A Consumer
that will call methods on ListPlatformApplicationsInput.Builder
to create a
request. Input for ListPlatformApplications action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listSmsSandboxPhoneNumbersRequest
- AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListSmsSandboxPhoneNumbersRequest.builder()
listSmsSandboxPhoneNumbersRequest
- A Consumer
that will call methods on ListSMSSandboxPhoneNumbersInput.Builder
to create a
request.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSMSSandboxPhoneNumbersIterable listSMSSandboxPhoneNumbersPaginator(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.
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 Stream
software.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersIterable responses = client.listSMSSandboxPhoneNumbersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
listSmsSandboxPhoneNumbersRequest
- AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSMSSandboxPhoneNumbersIterable listSMSSandboxPhoneNumbersPaginator(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 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 Stream
software.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersIterable responses = client.listSMSSandboxPhoneNumbersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via ListSmsSandboxPhoneNumbersRequest.builder()
listSmsSandboxPhoneNumbersRequest
- A Consumer
that will call methods on ListSMSSandboxPhoneNumbersInput.Builder
to create a
request.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSubscriptionsResponse listSubscriptions() 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 the NextToken
parameter
in a new ListSubscriptions
call to get further results.
This action is throttled at 30 transactions per second (TPS).
InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSubscriptions(ListSubscriptionsRequest)
,
AWS API
Documentationdefault 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 the NextToken
parameter
in a new ListSubscriptions
call to get further results.
This action is throttled at 30 transactions per second (TPS).
listSubscriptionsRequest
- Input for ListSubscriptions action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the NextToken
parameter
in a new ListSubscriptions
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 via ListSubscriptionsRequest.builder()
listSubscriptionsRequest
- A Consumer
that will call methods on ListSubscriptionsInput.Builder
to create a request.
Input for ListSubscriptions action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSubscriptionsIterable listSubscriptionsPaginator() 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 the NextToken
parameter
in a new ListSubscriptions
call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Stream
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSubscriptionsPaginator(ListSubscriptionsRequest)
,
AWS API
Documentationdefault ListSubscriptionsIterable listSubscriptionsPaginator(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 the NextToken
parameter
in a new ListSubscriptions
call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Stream
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
listSubscriptionsRequest
- Input for ListSubscriptions action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSubscriptionsIterable listSubscriptionsPaginator(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 the NextToken
parameter
in a new ListSubscriptions
call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Stream
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via ListSubscriptionsRequest.builder()
listSubscriptionsRequest
- A Consumer
that will call methods on ListSubscriptionsInput.Builder
to create a request.
Input for ListSubscriptions action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the NextToken
parameter in a new ListSubscriptionsByTopic
call to get further results.
This action is throttled at 30 transactions per second (TPS).
listSubscriptionsByTopicRequest
- Input for ListSubscriptionsByTopic action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the NextToken
parameter in a new ListSubscriptionsByTopic
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 via ListSubscriptionsByTopicRequest.builder()
listSubscriptionsByTopicRequest
- A Consumer
that will call methods on ListSubscriptionsByTopicInput.Builder
to create a
request. Input for ListSubscriptionsByTopic action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSubscriptionsByTopicIterable listSubscriptionsByTopicPaginator(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 the NextToken
parameter in a new ListSubscriptionsByTopic
call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Stream
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicIterable responses = client.listSubscriptionsByTopicPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
listSubscriptionsByTopicRequest
- Input for ListSubscriptionsByTopic action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSubscriptionsByTopicIterable listSubscriptionsByTopicPaginator(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 the NextToken
parameter in a new ListSubscriptionsByTopic
call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Stream
software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicIterable responses = client.listSubscriptionsByTopicPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via ListSubscriptionsByTopicRequest.builder()
listSubscriptionsByTopicRequest
- A Consumer
that will call methods on ListSubscriptionsByTopicInput.Builder
to create a
request. Input for ListSubscriptionsByTopic action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listTagsForResourceRequest
- ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTopicsResponse listTopics() 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 the NextToken
parameter in a new
ListTopics
call to get further results.
This action is throttled at 30 transactions per second (TPS).
InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTopics(ListTopicsRequest)
,
AWS API
Documentationdefault 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 the NextToken
parameter in a new
ListTopics
call to get further results.
This action is throttled at 30 transactions per second (TPS).
listTopicsRequest
- InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the NextToken
parameter in a new
ListTopics
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 via ListTopicsRequest.builder()
listTopicsRequest
- A Consumer
that will call methods on ListTopicsInput.Builder
to create a request.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTopicsIterable listTopicsPaginator() 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 the NextToken
parameter in a new
ListTopics
call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Stream
software.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTopicsPaginator(ListTopicsRequest)
,
AWS API
Documentationdefault ListTopicsIterable listTopicsPaginator(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 the NextToken
parameter in a new
ListTopics
call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Stream
software.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
listTopicsRequest
- InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTopicsIterable listTopicsPaginator(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 the NextToken
parameter in a new
ListTopics
call to get further results.
This action is throttled at 30 transactions per second (TPS).
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 Stream
software.amazon.awssdk.services.sns.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via ListTopicsRequest.builder()
listTopicsRequest
- A Consumer
that will call methods on ListTopicsInput.Builder
to create a request.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
optInPhoneNumberRequest
- Input for the OptInPhoneNumber action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via OptInPhoneNumberRequest.builder()
optInPhoneNumberRequest
- A Consumer
that will call methods on OptInPhoneNumberInput.Builder
to create a request.
Input for the OptInPhoneNumber action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the CreatePlatformEndpoint
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.
publishRequest
- Input for Publish action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InvalidParameterValueException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.EndpointDisabledException
- Exception error indicating endpoint disabled.PlatformApplicationDisabledException
- Exception error indicating platform application disabled.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For
more information, see How
Key State Affects Use of a Customer Master Key in the Key Management Service Developer Guide.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits
in the Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.ValidationException
- Indicates that a parameter in the request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the CreatePlatformEndpoint
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 via PublishRequest.builder()
publishRequest
- A Consumer
that will call methods on PublishInput.Builder
to create a request. Input for
Publish action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InvalidParameterValueException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.EndpointDisabledException
- Exception error indicating endpoint disabled.PlatformApplicationDisabledException
- Exception error indicating platform application disabled.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For
more information, see How
Key State Affects Use of a Customer Master Key in the Key Management Service Developer Guide.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits
in the Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.ValidationException
- Indicates that a parameter in the request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
of n
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.
publishBatchRequest
- InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InvalidParameterValueException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.EndpointDisabledException
- Exception error indicating endpoint disabled.PlatformApplicationDisabledException
- Exception error indicating platform application disabled.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.BatchEntryIdsNotDistinctException
- Two or more batch entries in the request have the same Id
.BatchRequestTooLongException
- The length of all the batch messages put together is more than the limit.EmptyBatchRequestException
- The batch request doesn't contain any entries.InvalidBatchEntryIdException
- The Id
of a batch entry in a batch request doesn't abide by the specification.TooManyEntriesInBatchRequestException
- The batch request contains more entries than permissible.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For
more information, see How
Key State Affects Use of a Customer Master Key in the Key Management Service Developer Guide.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits
in the Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.ValidationException
- Indicates that a parameter in the request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
of n
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 via PublishBatchRequest.builder()
publishBatchRequest
- A Consumer
that will call methods on PublishBatchInput.Builder
to create a request.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InvalidParameterValueException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.EndpointDisabledException
- Exception error indicating endpoint disabled.PlatformApplicationDisabledException
- Exception error indicating platform application disabled.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.BatchEntryIdsNotDistinctException
- Two or more batch entries in the request have the same Id
.BatchRequestTooLongException
- The length of all the batch messages put together is more than the limit.EmptyBatchRequestException
- The batch request doesn't contain any entries.InvalidBatchEntryIdException
- The Id
of a batch entry in a batch request doesn't abide by the specification.TooManyEntriesInBatchRequestException
- The batch request contains more entries than permissible.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For
more information, see How
Key State Affects Use of a Customer Master Key in the Key Management Service Developer Guide.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits
in the Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.ValidationException
- Indicates that a parameter in the request is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
putDataProtectionPolicyRequest
- InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via PutDataProtectionPolicyRequest.builder()
putDataProtectionPolicyRequest
- A Consumer
that will call methods on PutDataProtectionPolicyInput.Builder
to create a
request.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and SetTopicAttributes
actions in your IAM policy.
removePermissionRequest
- Input for RemovePermission action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and SetTopicAttributes
actions in your IAM policy.
This is a convenience which creates an instance of the RemovePermissionRequest.Builder
avoiding the need
to create one manually via RemovePermissionRequest.builder()
removePermissionRequest
- A Consumer
that will call methods on RemovePermissionInput.Builder
to create a request.
Input for RemovePermission action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
setEndpointAttributesRequest
- Input for SetEndpointAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via SetEndpointAttributesRequest.builder()
setEndpointAttributesRequest
- A Consumer
that will call methods on SetEndpointAttributesInput.Builder
to create a
request. Input for SetEndpointAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
setPlatformApplicationAttributesRequest
- Input for SetPlatformApplicationAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via SetPlatformApplicationAttributesRequest.builder()
setPlatformApplicationAttributesRequest
- A Consumer
that will call methods on SetPlatformApplicationAttributesInput.Builder
to
create a request. Input for SetPlatformApplicationAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
the MessageAttributes.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 the s3:ListBucket
action.
setSmsAttributesRequest
- The input for the SetSMSAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
the MessageAttributes.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 the s3:ListBucket
action.
This is a convenience which creates an instance of the SetSmsAttributesRequest.Builder
avoiding the need
to create one manually via SetSmsAttributesRequest.builder()
setSmsAttributesRequest
- A Consumer
that will call methods on SetSMSAttributesInput.Builder
to create a request.
The input for the SetSMSAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SetSubscriptionAttributesResponse setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws InvalidParameterException, FilterPolicyLimitExceededException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SnsException
Allows a subscription owner to set an attribute of the subscription to a new value.
setSubscriptionAttributesRequest
- Input for SetSubscriptionAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add
more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SetSubscriptionAttributesResponse setSubscriptionAttributes(Consumer<SetSubscriptionAttributesRequest.Builder> setSubscriptionAttributesRequest) throws InvalidParameterException, FilterPolicyLimitExceededException, 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 via SetSubscriptionAttributesRequest.builder()
setSubscriptionAttributesRequest
- A Consumer
that will call methods on SetSubscriptionAttributesInput.Builder
to create a
request. Input for SetSubscriptionAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add
more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and SetTopicAttributes
actions in your IAM policy.
setTopicAttributesRequest
- Input for SetTopicAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
, and SetTopicAttributes
actions in your IAM policy.
This is a convenience which creates an instance of the SetTopicAttributesRequest.Builder
avoiding the
need to create one manually via SetTopicAttributesRequest.builder()
setTopicAttributesRequest
- A Consumer
that will call methods on SetTopicAttributesInput.Builder
to create a request.
Input for SetTopicAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SubscribeResponse subscribe(SubscribeRequest subscribeRequest) throws SubscriptionLimitExceededException, FilterPolicyLimitExceededException, 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 three days.
This action is throttled at 100 transactions per second (TPS).
subscribeRequest
- Input for Subscribe action.SubscriptionLimitExceededException
- Indicates that the customer already owns the maximum allowed number of subscriptions.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add
more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SubscribeResponse subscribe(Consumer<SubscribeRequest.Builder> subscribeRequest) throws SubscriptionLimitExceededException, FilterPolicyLimitExceededException, 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 three 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 via SubscribeRequest.builder()
subscribeRequest
- A Consumer
that will call methods on SubscribeInput.Builder
to create a request. Input for
Subscribe action.SubscriptionLimitExceededException
- Indicates that the customer already owns the maximum allowed number of subscriptions.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add
more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
tagResourceRequest
- ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the Unsubscribe
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).
unsubscribeRequest
- Input for Unsubscribe action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 the Unsubscribe
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 via UnsubscribeRequest.builder()
unsubscribeRequest
- A Consumer
that will call methods on UnsubscribeInput.Builder
to create a request. Input
for Unsubscribe action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.NotFoundException
- Indicates that the requested resource does not exist.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
untagResourceRequest
- ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
verifySmsSandboxPhoneNumberRequest
- AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.VerificationException
- Indicates that the one-time password (OTP) used for verification is invalid.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via VerifySmsSandboxPhoneNumberRequest.builder()
verifySmsSandboxPhoneNumberRequest
- A Consumer
that will call methods on VerifySMSSandboxPhoneNumberInput.Builder
to create a
request.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InternalErrorException
- Indicates an internal service error.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ResourceNotFoundException
- Can’t perform the action on the specified resource. Make sure that the resource exists.VerificationException
- Indicates that the one-time password (OTP) used for verification is invalid.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
Amazon Web Services account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static SnsClient create()
SnsClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SnsClientBuilder builder()
SnsClient
.static ServiceMetadata serviceMetadata()
Copyright © 2023. All rights reserved.