@Generated(value="software.amazon.awssdk:codegen") public interface SNSClient extends SdkClient, SdkAutoCloseable
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 http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see 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_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 AWS 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 AWS 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
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
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,
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,
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
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
and APNS.
|
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.
|
default DeletePlatformApplicationResponse |
deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
|
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 GetEndpointAttributesResponse |
getEndpointAttributes(Consumer<GetEndpointAttributesRequest.Builder> getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM
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
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.
|
default GetPlatformApplicationAttributesResponse |
getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the supported push notification services, such as
APNS and GCM.
|
default GetSMSAttributesResponse |
getSMSAttributes()
Returns the settings for sending SMS messages from your account.
|
default GetSMSAttributesResponse |
getSMSAttributes(Consumer<GetSMSAttributesRequest.Builder> getSMSAttributesRequest)
Returns the settings for sending SMS messages from your account.
|
default GetSMSAttributesResponse |
getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest)
Returns the settings for sending SMS messages from your account.
|
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 and
APNS.
|
default ListEndpointsByPlatformApplicationResponse |
listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM 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 and
APNS.
|
default ListEndpointsByPlatformApplicationIterable |
listEndpointsByPlatformApplicationPaginator(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and
APNS.
|
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 ListPlatformApplicationsResponse |
listPlatformApplications()
Lists the platform application objects for the supported push notification services, such as APNS and GCM.
|
default ListPlatformApplicationsResponse |
listPlatformApplications(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and GCM.
|
default ListPlatformApplicationsResponse |
listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and GCM.
|
default ListPlatformApplicationsIterable |
listPlatformApplicationsPaginator()
Lists the platform application objects for the supported push notification services, such as APNS and GCM.
|
default ListPlatformApplicationsIterable |
listPlatformApplicationsPaginator(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push notification services, such as APNS and GCM.
|
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(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
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(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 all of a topic's subscribed endpoints.
|
default PublishResponse |
publish(PublishRequest publishRequest)
Sends a message to all of a topic's subscribed endpoints.
|
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
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
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.
|
default SetPlatformApplicationAttributesResponse |
setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
Sets the attributes of the platform application object for the supported push notification services, such as APNS
and GCM.
|
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 topic to a new value.
|
default SetSubscriptionAttributesResponse |
setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the topic 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)
Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
|
default SubscribeResponse |
subscribe(SubscribeRequest subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
|
default UnsubscribeResponse |
unsubscribe(Consumer<UnsubscribeRequest.Builder> unsubscribeRequest)
Deletes a subscription.
|
default UnsubscribeResponse |
unsubscribe(UnsubscribeRequest unsubscribeRequest)
Deletes a subscription.
|
serviceNameclosestatic final String SERVICE_NAME
static SNSClient create()
SNSClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SNSClientBuilder builder()
SNSClient.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 AWS accounts to the specified actions.
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.AwsServiceExceptiondefault 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 AWS accounts to the specified actions.
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.AwsServiceExceptiondefault 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 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
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.AwsServiceExceptiondefault 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 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
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.AwsServiceExceptiondefault ConfirmSubscriptionResponse confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest) throws SubscriptionLimitExceededException, InvalidParameterException, NotFoundException, InternalErrorException, AuthorizationErrorException, 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.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.AwsServiceExceptiondefault ConfirmSubscriptionResponse confirmSubscription(Consumer<ConfirmSubscriptionRequest.Builder> confirmSubscriptionRequest) throws SubscriptionLimitExceededException, InvalidParameterException, NotFoundException, InternalErrorException, AuthorizationErrorException, 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.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.AwsServiceExceptiondefault 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,
to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential
attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from
the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM,
PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also
received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential
is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when
using CreatePlatformApplication is then used as an attribute for the
CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push
Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of
the supported push notification services, see Getting Started with Apple Push
Notification Service, Getting Started
with Amazon Device Messaging, Getting Started with Baidu Cloud Push,
Getting Started with Google Cloud
Messaging for Android, Getting
Started with MPNS, or Getting Started
with WNS.
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.AwsServiceExceptiondefault 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,
to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential
attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from
the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM,
PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also
received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential
is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when
using CreatePlatformApplication is then used as an attribute for the
CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push
Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of
the supported push notification services, see Getting Started with Apple Push
Notification Service, Getting Started
with Amazon Device Messaging, Getting Started with Baidu Cloud Push,
Getting Started with Google Cloud
Messaging for Android, Getting
Started with MPNS, or Getting Started
with WNS.
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.AwsServiceExceptiondefault 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
and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from
CreatePlatformApplication. The EndpointArn that is returned when using
CreatePlatformEndpoint can then be used by the Publish action 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.AwsServiceExceptiondefault 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
and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from
CreatePlatformApplication. The EndpointArn that is returned when using
CreatePlatformEndpoint can then be used by the Publish action 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.AwsServiceExceptiondefault CreateTopicResponse createTopic(CreateTopicRequest createTopicRequest) throws InvalidParameterException, TopicLimitExceededException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. 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.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.AwsServiceExceptiondefault CreateTopicResponse createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest) throws InvalidParameterException, TopicLimitExceededException, InternalErrorException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. 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.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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. 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.AwsServiceExceptiondefault 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. 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.AwsServiceExceptiondefault DeleteTopicResponse deleteTopic(DeleteTopicRequest deleteTopicRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, 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.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.AwsServiceExceptiondefault DeleteTopicResponse deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, 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.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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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. 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.AwsServiceExceptiondefault 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. 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.AwsServiceExceptiondefault GetSMSAttributesResponse getSMSAttributes() throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SNSException
Returns the settings for sending SMS messages from your 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
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.AwsServiceExceptiongetSMSAttributes(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 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
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.AwsServiceExceptiondefault GetSMSAttributesResponse getSMSAttributes(Consumer<GetSMSAttributesRequest.Builder> getSMSAttributesRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, AwsServiceException, SdkClientException, SNSException
Returns the settings for sending SMS messages from your 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
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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault GetTopicAttributesResponse getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, 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.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.AwsServiceExceptiondefault GetTopicAttributesResponse getTopicAttributes(Consumer<GetTopicAttributesRequest.Builder> getTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, 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.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.AwsServiceExceptiondefault 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 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.
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.AwsServiceExceptiondefault 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 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 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.AwsServiceExceptiondefault 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 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 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(....);
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.AwsServiceExceptiondefault 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 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 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(....);
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.AwsServiceExceptiondefault 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
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.AwsServiceExceptionlistPhoneNumbersOptedOut(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
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.AwsServiceExceptiondefault 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
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.AwsServiceExceptiondefault 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. 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.
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.AwsServiceExceptionlistPlatformApplications(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. 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.
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.AwsServiceExceptiondefault 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. 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 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.AwsServiceExceptiondefault 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. 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 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(....);
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.AwsServiceExceptiondefault 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. 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 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(....);
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.AwsServiceExceptionlistPlatformApplicationsPaginator(ListPlatformApplicationsRequest),
AWS
API Documentationdefault 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.
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.AwsServiceExceptionlistSubscriptions(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.
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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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(....);
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.AwsServiceExceptiondefault 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 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(....);
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.AwsServiceExceptionlistSubscriptionsPaginator(ListSubscriptionsRequest),
AWS API
Documentationdefault 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.
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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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(....);
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.AwsServiceExceptiondefault 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 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(....);
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.AwsServiceExceptiondefault 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.
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.AwsServiceExceptionlistTopics(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.
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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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(....);
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.AwsServiceExceptiondefault 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 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(....);
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.AwsServiceExceptionlistTopicsPaginator(ListTopicsRequest),
AWS API
Documentationdefault 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
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.AwsServiceExceptiondefault 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
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.AwsServiceExceptiondefault PublishResponse publish(PublishRequest publishRequest) throws InvalidParameterException, InvalidParameterValueException, InternalErrorException, NotFoundException, EndpointDisabledException, PlatformApplicationDisabledException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message
has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the
outgoing message to each subscribed endpoint depends on the notification protocol.
To use the Publish action for sending 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.
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.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.AwsServiceExceptiondefault PublishResponse publish(Consumer<PublishRequest.Builder> publishRequest) throws InvalidParameterException, InvalidParameterValueException, InternalErrorException, NotFoundException, EndpointDisabledException, PlatformApplicationDisabledException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message
has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the
outgoing message to each subscribed endpoint depends on the notification protocol.
To use the Publish action for sending 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.
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.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.AwsServiceExceptiondefault RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SNSException
Removes a statement from a topic's access control 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.AwsServiceExceptiondefault RemovePermissionResponse removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, AwsServiceException, SdkClientException, SNSException
Removes a statement from a topic's access control 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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. 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.AwsServiceExceptiondefault 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. 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.AwsServiceExceptiondefault 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 Sending an SMS Message in the
Amazon SNS Developer Guide.
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
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.AwsServiceExceptiondefault 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 Sending an SMS Message in the
Amazon SNS Developer Guide.
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
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.AwsServiceExceptiondefault SetSubscriptionAttributesResponse setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Allows a subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesRequest - Input for SetSubscriptionAttributes 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.AwsServiceExceptiondefault SetSubscriptionAttributesResponse setSubscriptionAttributes(Consumer<SetSubscriptionAttributesRequest.Builder> setSubscriptionAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Allows a subscription owner to set an attribute of the topic 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.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.AwsServiceExceptiondefault SetTopicAttributesResponse setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Allows a topic owner to set an attribute of the topic to a new value.
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.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.AwsServiceExceptiondefault SetTopicAttributesResponse setTopicAttributes(Consumer<SetTopicAttributesRequest.Builder> setTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Allows a topic owner to set an attribute of the topic to a new value.
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.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.AwsServiceExceptiondefault SubscribeResponse subscribe(SubscribeRequest subscribeRequest) throws SubscriptionLimitExceededException, InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a
subscription, the endpoint owner must call the ConfirmSubscription action with the token from the
confirmation message. Confirmation tokens are valid for three days.
subscribeRequest - Input for Subscribe 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.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.AwsServiceExceptiondefault SubscribeResponse subscribe(Consumer<SubscribeRequest.Builder> subscribeRequest) throws SubscriptionLimitExceededException, InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, AwsServiceException, SdkClientException, SNSException
Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a
subscription, the endpoint owner must call the ConfirmSubscription action with the token from the
confirmation message. Confirmation tokens are valid for three days.
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.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.AwsServiceExceptiondefault UnsubscribeResponse unsubscribe(UnsubscribeRequest unsubscribeRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, 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 AWS 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.
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.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.AwsServiceExceptiondefault UnsubscribeResponse unsubscribe(Consumer<UnsubscribeRequest.Builder> unsubscribeRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, 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 AWS 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.
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.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.