public class AmazonSNSClient extends AmazonWebServiceClient implements AmazonSNS
Amazon Simple Notification Service
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 Getting Started 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 .
| 修飾子とタイプ | フィールドと説明 |
|---|---|
protected java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all AmazonSNS exceptions.
|
client, clientConfiguration, endpoint, requestHandlers, timeOffset, version| コンストラクタと説明 |
|---|
AmazonSNSClient()
Constructs a new client to invoke service methods on
AmazonSNS.
|
AmazonSNSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonSNS using the specified AWS account credentials.
|
AmazonSNSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonSNS using the specified AWS account credentials
and client configuration options.
|
AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonSNS using the specified AWS account credentials provider.
|
AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonSNS using the specified AWS account credentials
provider and client configuration options.
|
AmazonSNSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonSNS.
|
| 修飾子とタイプ | メソッドと説明 |
|---|---|
void |
addPermission(AddPermissionRequest addPermissionRequest)
The
AddPermission action adds a statement to a topic's
access control policy, granting access for the specified AWS accounts
to the specified actions. |
ConfirmSubscriptionResult |
confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)
The
ConfirmSubscription action verifies an endpoint
owner's intent to receive messages by validating the token sent to the
endpoint by an earlier Subscribe action. |
CreateTopicResult |
createTopic(CreateTopicRequest createTopicRequest)
The
CreateTopic action creates a topic to which
notifications can be published. |
void |
deleteTopic(DeleteTopicRequest deleteTopicRequest)
The
DeleteTopic action deletes a topic and all its
subscriptions. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for
debugging issues where a service isn't acting as expected.
|
protected java.lang.String |
getServiceAbbreviation()
リージョンによるサービスエンドポイントを特定するために、このサービスに対する
略称を返します
|
GetSubscriptionAttributesResult |
getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
The
GetSubscriptionAttribtues action returns all of the
properties of a subscription. |
GetTopicAttributesResult |
getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)
The
GetTopicAttributes action returns all of the
properties of a topic. |
ListSubscriptionsResult |
listSubscriptions()
The
ListSubscriptions action returns a list of the
requester's subscriptions. |
ListSubscriptionsResult |
listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)
The
ListSubscriptions action returns a list of the
requester's subscriptions. |
ListSubscriptionsByTopicResult |
listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
The
ListSubscriptionsByTopic action returns a list of the
subscriptions to a specific topic. |
ListTopicsResult |
listTopics()
The
ListTopics action returns a list of the requester's
topics. |
ListTopicsResult |
listTopics(ListTopicsRequest listTopicsRequest)
The
ListTopics action returns a list of the requester's
topics. |
PublishResult |
publish(PublishRequest publishRequest)
The
Publish action sends a message to all of a topic's
subscribed endpoints. |
void |
removePermission(RemovePermissionRequest removePermissionRequest)
The
RemovePermission action removes a statement from a
topic's access control policy. |
void |
setEndpoint(java.lang.String endpoint,
java.lang.String serviceName,
java.lang.String regionId)
Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com") and explicitly provides
an AWS region ID and AWS service name to use when the client calculates a signature
for requests.
|
void |
setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
The
SetSubscriptionAttributes action allows a
subscription owner to set an attribute of the topic to a new value. |
void |
setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)
The
SetTopicAttributes action allows a topic owner to set
an attribute of the topic to a new value. |
SubscribeResult |
subscribe(SubscribeRequest subscribeRequest)
The
Subscribe action prepares to subscribe an endpoint by
sending the endpoint a confirmation message. |
void |
unsubscribe(UnsubscribeRequest unsubscribeRequest)
The
Unsubscribe action deletes a subscription. |
addRequestHandler, convertToHttpRequest, createExecutionContext, getTimeOffset, getVersion, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, setVersion, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected final java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>> exceptionUnmarshallers
public AmazonSNSClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderpublic AmazonSNSClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
client connects to AmazonSNS
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderpublic AmazonSNSClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonSNSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonSNS
(ex: proxy settings, retry counts, etc.).public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonSNS
(ex: proxy settings, retry counts, etc.).public ConfirmSubscriptionResult confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest) throws AmazonServiceException, AmazonClientException
The ConfirmSubscription action 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".
confirmSubscription インタフェース内 AmazonSNSconfirmSubscriptionRequest - Container for the necessary
parameters to execute the ConfirmSubscription service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionSubscriptionLimitExceededExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public GetTopicAttributesResult getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
The GetTopicAttributes action returns all of the
properties of a topic. Topic properties returned might differ based on
the authorization of the user.
getTopicAttributes インタフェース内 AmazonSNSgetTopicAttributesRequest - Container for the necessary
parameters to execute the GetTopicAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public SubscribeResult subscribe(SubscribeRequest subscribeRequest) throws AmazonServiceException, AmazonClientException
The Subscribe action 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.
subscribe インタフェース内 AmazonSNSsubscribeRequest - Container for the necessary parameters to
execute the Subscribe service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionSubscriptionLimitExceededExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public void setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
The SetTopicAttributes action allows a topic owner to set
an attribute of the topic to a new value.
setTopicAttributes インタフェース内 AmazonSNSsetTopicAttributesRequest - Container for the necessary
parameters to execute the SetTopicAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public void deleteTopic(DeleteTopicRequest deleteTopicRequest) throws AmazonServiceException, AmazonClientException
The DeleteTopic action 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.
deleteTopic インタフェース内 AmazonSNSdeleteTopicRequest - Container for the necessary parameters to
execute the DeleteTopic service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public void removePermission(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException
The RemovePermission action removes a statement from a
topic's access control policy.
removePermission インタフェース内 AmazonSNSremovePermissionRequest - Container for the necessary parameters
to execute the RemovePermission service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public ListSubscriptionsResult listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) throws AmazonServiceException, AmazonClientException
The ListSubscriptions action 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.
listSubscriptions インタフェース内 AmazonSNSlistSubscriptionsRequest - Container for the necessary parameters
to execute the ListSubscriptions service method on AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public void setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
The SetSubscriptionAttributes action allows a
subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributes インタフェース内 AmazonSNSsetSubscriptionAttributesRequest - Container for the necessary
parameters to execute the SetSubscriptionAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public void addPermission(AddPermissionRequest addPermissionRequest) throws AmazonServiceException, AmazonClientException
The AddPermission action adds a statement to a topic's
access control policy, granting access for the specified AWS accounts
to the specified actions.
addPermission インタフェース内 AmazonSNSaddPermissionRequest - Container for the necessary parameters to
execute the AddPermission service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public CreateTopicResult createTopic(CreateTopicRequest createTopicRequest) throws AmazonServiceException, AmazonClientException
The CreateTopic action creates a topic to which
notifications can be published. Users can create at most 100 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.
createTopic インタフェース内 AmazonSNScreateTopicRequest - Container for the necessary parameters to
execute the CreateTopic service method on AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionTopicLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
The GetSubscriptionAttribtues action returns all of the
properties of a subscription.
getSubscriptionAttributes インタフェース内 AmazonSNSgetSubscriptionAttributesRequest - Container for the necessary
parameters to execute the GetSubscriptionAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public ListTopicsResult listTopics(ListTopicsRequest listTopicsRequest) throws AmazonServiceException, AmazonClientException
The ListTopics action 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.
listTopics インタフェース内 AmazonSNSlistTopicsRequest - Container for the necessary parameters to
execute the ListTopics service method on AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public void unsubscribe(UnsubscribeRequest unsubscribeRequest) throws AmazonServiceException, AmazonClientException
The Unsubscribe action deletes a subscription. If the
subscription requires authentication for deletion, only the owner of
the subscription or the its 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.
unsubscribe インタフェース内 AmazonSNSunsubscribeRequest - Container for the necessary parameters to
execute the Unsubscribe service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public ListSubscriptionsByTopicResult listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) throws AmazonServiceException, AmazonClientException
The ListSubscriptionsByTopic action 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.
listSubscriptionsByTopic インタフェース内 AmazonSNSlistSubscriptionsByTopicRequest - Container for the necessary
parameters to execute the ListSubscriptionsByTopic service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public PublishResult publish(PublishRequest publishRequest) throws AmazonServiceException, AmazonClientException
The Publish action 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
selected.
publish インタフェース内 AmazonSNSpublishRequest - Container for the necessary parameters to
execute the Publish service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public ListSubscriptionsResult listSubscriptions() throws AmazonServiceException, AmazonClientException
The ListSubscriptions action 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.
listSubscriptions インタフェース内 AmazonSNSAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public ListTopicsResult listTopics() throws AmazonServiceException, AmazonClientException
The ListTopics action 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.
listTopics インタフェース内 AmazonSNSAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(java.lang.String endpoint,
java.lang.String serviceName,
java.lang.String regionId)
throws java.lang.IllegalArgumentException
This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
Callers can pass in just the endpoint (ex: "sns.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex: "https://sns.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
endpoint - The endpoint (ex: "sns.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://sns.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.serviceName - The name of the AWS service to use when signing requests.regionId - The ID of the region in which this service resides.java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.protected java.lang.String getServiceAbbreviation()
AmazonWebServiceClientgetServiceAbbreviation クラス内 AmazonWebServiceClientServiceAbbreviationspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata インタフェース内 AmazonSNSrequest - The originally executed request