com.amazonaws.services.sns

## インタフェース AmazonSNS

- 既知のサブインタフェースのリスト:
    AmazonSNSAsync
  既知の実装クラスのリスト:
    AmazonSNSAsyncClient, AmazonSNSClient

      public interface AmazonSNS

  Interface for accessing 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 .

- - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `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.
    `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)` Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com").
    `void` | `setRegion(Region region)` An alternative to `setEndpoint(String)`, sets the regional endpoint for this client's service calls.
    `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.
    `void` | `shutdown()` Shuts down this client object, releasing any resources that might be held open.
    `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.

- - ### メソッドの詳細

    - #### setEndpoint

          void setEndpoint(java.lang.String endpoint)
                           throws java.lang.IllegalArgumentException

      Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

      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

      This method is not threadsafe. An endpoint 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 or retrying.

      パラメータ:
        `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.
      例外:
        `java.lang.IllegalArgumentException` - If any problems are detected with the specified endpoint.

    - #### setRegion

          void setRegion(Region region)
                         throws java.lang.IllegalArgumentException

      An alternative to `setEndpoint(String)`, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

      By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the `ClientConfiguration` supplied at construction.

      This method is not threadsafe. A region 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 or retrying.

      パラメータ:
        `region` - The region this client will communicate with. See `Region.getRegion(com.amazonaws.regions.Regions)` for accessing a given region.
      例外:
        `java.lang.IllegalArgumentException` - If the given region is null, or if this service isn't available in the given region. See `Region.isServiceSupported(String)`
      関連項目:
        `Region.getRegion(com.amazonaws.regions.Regions)`, `Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)`

    - #### confirmSubscription

          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".

      パラメータ:
        `confirmSubscriptionRequest` - Container for the necessary parameters to execute the ConfirmSubscription service method on AmazonSNS.
      戻り値:
        The response from the ConfirmSubscription service method, as returned by AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `SubscriptionLimitExceededException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### getTopicAttributes

          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.

      パラメータ:
        `getTopicAttributesRequest` - Container for the necessary parameters to execute the GetTopicAttributes service method on AmazonSNS.
      戻り値:
        The response from the GetTopicAttributes service method, as returned by AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### subscribe

          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.

      パラメータ:
        `subscribeRequest` - Container for the necessary parameters to execute the Subscribe service method on AmazonSNS.
      戻り値:
        The response from the Subscribe service method, as returned by AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `SubscriptionLimitExceededException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### setTopicAttributes

          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.

      パラメータ:
        `setTopicAttributesRequest` - Container for the necessary parameters to execute the SetTopicAttributes service method on AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### deleteTopic

          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.

      パラメータ:
        `deleteTopicRequest` - Container for the necessary parameters to execute the DeleteTopic service method on AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### removePermission

          void removePermission(RemovePermissionRequest removePermissionRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

      The `RemovePermission` action removes a statement from a topic's access control policy.

      パラメータ:
        `removePermissionRequest` - Container for the necessary parameters to execute the RemovePermission service method on AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### listSubscriptions

          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.

      パラメータ:
        `listSubscriptionsRequest` - Container for the necessary parameters to execute the ListSubscriptions service method on AmazonSNS.
      戻り値:
        The response from the ListSubscriptions service method, as returned by AmazonSNS.
      例外:
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### setSubscriptionAttributes

          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.

      パラメータ:
        `setSubscriptionAttributesRequest` - Container for the necessary parameters to execute the SetSubscriptionAttributes service method on AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### addPermission

          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.

      パラメータ:
        `addPermissionRequest` - Container for the necessary parameters to execute the AddPermission service method on AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### createTopic

          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.

      パラメータ:
        `createTopicRequest` - Container for the necessary parameters to execute the CreateTopic service method on AmazonSNS.
      戻り値:
        The response from the CreateTopic service method, as returned by AmazonSNS.
      例外:
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `TopicLimitExceededException`
        `AmazonClientException` - 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.

    - #### getSubscriptionAttributes

          GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

      The `GetSubscriptionAttribtues` action returns all of the properties of a subscription.

      パラメータ:
        `getSubscriptionAttributesRequest` - Container for the necessary parameters to execute the GetSubscriptionAttributes service method on AmazonSNS.
      戻り値:
        The response from the GetSubscriptionAttributes service method, as returned by AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### listTopics

          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.

      パラメータ:
        `listTopicsRequest` - Container for the necessary parameters to execute the ListTopics service method on AmazonSNS.
      戻り値:
        The response from the ListTopics service method, as returned by AmazonSNS.
      例外:
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### unsubscribe

          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.

      パラメータ:
        `unsubscribeRequest` - Container for the necessary parameters to execute the Unsubscribe service method on AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### listSubscriptionsByTopic

          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.

      パラメータ:
        `listSubscriptionsByTopicRequest` - Container for the necessary parameters to execute the ListSubscriptionsByTopic service method on AmazonSNS.
      戻り値:
        The response from the ListSubscriptionsByTopic service method, as returned by AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### publish

          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.

      パラメータ:
        `publishRequest` - Container for the necessary parameters to execute the Publish service method on AmazonSNS.
      戻り値:
        The response from the Publish service method, as returned by AmazonSNS.
      例外:
        `NotFoundException`
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### listSubscriptions

          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.

      戻り値:
        The response from the ListSubscriptions service method, as returned by AmazonSNS.
      例外:
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### listTopics

          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.

      戻り値:
        The response from the ListTopics service method, as returned by AmazonSNS.
      例外:
        `AuthorizationErrorException`
        `InternalErrorException`
        `InvalidParameterException`
        `AmazonClientException` - 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.

    - #### shutdown

          void shutdown()

      Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

    - #### getCachedResponseMetadata

          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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

      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 a request.

      パラメータ:
        `request` - The originally executed request.
      戻り値:
        The response metadata for the specified request, or null if none is available.