com.amazonaws.services.sqs

## インタフェース AmazonSQS

- 既知のサブインタフェースのリスト:
    AmazonSQSAsync
  既知の実装クラスのリスト:
    AmazonSQSAsyncClient, AmazonSQSBufferedAsyncClient, AmazonSQSClient

      public interface AmazonSQS

  AmazonSQS にアクセスするためのインタフェース

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

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addPermission(AddPermissionRequest addPermissionRequest)`
    `void` | `changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)`
    `ChangeMessageVisibilityBatchResult` | `changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)`
    `CreateQueueResult` | `createQueue(CreateQueueRequest createQueueRequest)`
    `void` | `deleteMessage(DeleteMessageRequest deleteMessageRequest)`
    `DeleteMessageBatchResult` | `deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)`
    `void` | `deleteQueue(DeleteQueueRequest deleteQueueRequest)`
    `ResponseMetadata` | `getCachedResponseMetadata(AmazonWebServiceRequest request)` 期待どおりにサービスが動作しない問題をデバッグするため、以前に成功した際のメタデータを返します。
    `GetQueueAttributesResult` | `getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)`
    `GetQueueUrlResult` | `getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)`
    `ListQueuesResult` | `listQueues()`
    `ListQueuesResult` | `listQueues(ListQueuesRequest listQueuesRequest)`
    `NiftyGetMetricStatisticsResult` | `niftyGetMetricStatistics(NiftyGetMetricStatisticsRequest niftyGetMetricStatisticsRequest)` モニタリング情報を取得します。
    `ReceiveMessageResult` | `niftyReceiveAndDeleteMessage(ReceiveMessageRequest receivMessageRequest)`
    `ReceiveMessageResult` | `receiveMessage(ReceiveMessageRequest receiveMessageRequest)`
    `void` | `removePermission(RemovePermissionRequest removePermissionRequest)`
    `SendMessageResult` | `sendMessage(SendMessageRequest sendMessageRequest)`
    `SendMessageBatchResult` | `sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)`
    `void` | `setEndpoint(java.lang.String endpoint)` このクライアント ("sqs.us-east-1.amazonaws.com") のデフォルトエンドポイントを上書きします。
    `void` | `setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)`
    `void` | `setRegion(Region region)` `setEndpoint(String)` する代わりに、サービスコールのための リージョン・エンドポイントを設定します。
    `void` | `shutdown()` このクライアントオブジェクトをシャットダウンし、 開いたままである可能性のあるリソースを解放します。

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

    - #### setEndpoint

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

      このクライアント ("sqs.us-east-1.amazonaws.com") のデフォルトエンドポイントを上書きします。 呼び出し元は、AWS領域をコントロールするためにこのメソッドを使用できます。

      呼び出し元は、エンドポイント(例："sqs.us-east-1.amazonaws.com")、またはプロトコル (例："https://sqs.us-east-1.amazonaws.com")を含む、完全な URL を渡すことができます プロトコルが指定されない場合は、このクライアントのデフォルトプロトコル`ClientConfiguration`が 使用されます。デフォルトプロトコルはHTTPSです。

      AWS SDK for JavaでAWS領域を使用するための詳細情報、および AWSサービスで利用可能なすべてのエンドポイントリストについては以下を参照してください。 http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

      このメソッドはスレッドセーフではありません。 すべてのサービスリクエストの前に、クライアントが生成され、エンドポイントが構成される必要があります。 生成後に変更した場合、サービスリクエスト中に競合状態が発生します。

      パラメータ:
        `endpoint` - このクライアントが通信するAWS領域のエンドポイント(例："mq.jp-east-1.api.cloud.nifty.com")、 またはプロトコル(例："mq.jp-east-1.api.cloud.nifty.com")を含む、完全な URL。
      例外:
        `java.lang.IllegalArgumentException` - 特定のエンドポイントで検出された問題

    - #### setRegion

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

      `setEndpoint(String)` する代わりに、サービスコールのための リージョン・エンドポイントを設定します。 呼び出し元は、AWS領域を使用するためにこのメソッドを使用する事ができます。

      デフォルトでは、すべてのサービスエンドポイントは https プロトコルを使用します。 http を使用するには、生成時に `ClientConfiguration` で指定します。

      すべてのサービスリクエストの前に、クライアントが生成され、リージョンが設定される必要があります。 生成後に変更した場合、サービスリクエスト中に競合状態が発生します。

      パラメータ:
        `region` - このクライアントが通信するリージョン。特定のリージョンにアクセスするためには `Region#getRegion(com.nifty.cloud.regions.Regions)` を参照してください。
      例外:
        `java.lang.IllegalArgumentException` - 指定したリージョンがnull の場合、またはサービスが使用できない場合は以下を参照してください。 `Region.isServiceSupported(String)`
      関連項目:
        `Region.getRegion(com.amazonaws.regions.Regions)`, `Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)`

    - #### setQueueAttributes

          void setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

      パラメータ:
        `setQueueAttributesRequest` - AmazonSQS上で SetQueueAttributes サービスメソッドを実行するために必要なパラメータ用のコンテナ
      例外:
        `InvalidAttributeNameException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### changeMessageVisibilityBatch

          ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

      パラメータ:
        `changeMessageVisibilityBatchRequest` - AmazonSQS上で ChangeMessageVisibilityBatch サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQSによって返される ChangeMessageVisibilityBatch サービスメソッドからの戻り値
      例外:
        `BatchEntryIdsNotDistinctException`
        `TooManyEntriesInBatchRequestException`
        `InvalidBatchEntryIdException`
        `EmptyBatchRequestException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### changeMessageVisibility

          void changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

      パラメータ:
        `changeMessageVisibilityRequest` - AmazonSQS上で ChangeMessageVisibility サービスメソッドを実行するために必要なパラメータ用のコンテナ
      例外:
        `ReceiptHandleIsInvalidException`
        `MessageNotInflightException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### getQueueUrl

          GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

      パラメータ:
        `getQueueUrlRequest` - AmazonSQS上で GetQueueUrl サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される GetQueueUrl サービスメソッドからの戻り値
      例外:
        `QueueDoesNotExistException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### removePermission

          void removePermission(RemovePermissionRequest removePermissionRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

      パラメータ:
        `removePermissionRequest` - AmazonSQS上で RemovePermission サービスメソッドを実行するために必要なパラメータ用のコンテナ
      例外:
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### getQueueAttributes

          GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

      パラメータ:
        `getQueueAttributesRequest` - AmazonSQS上で GetQueueAttributes サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される GetQueueAttributes サービスメソッドからの戻り値
      例外:
        `InvalidAttributeNameException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### sendMessageBatch

          SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

      パラメータ:
        `sendMessageBatchRequest` - AmazonSQS上で SendMessageBatch サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される SendMessageBatch サービスメソッドからの戻り値
      例外:
        `BatchEntryIdsNotDistinctException`
        `TooManyEntriesInBatchRequestException`
        `BatchRequestTooLongException`
        `InvalidBatchEntryIdException`
        `EmptyBatchRequestException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### deleteQueue

          void deleteQueue(DeleteQueueRequest deleteQueueRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

      パラメータ:
        `deleteQueueRequest` - AmazonSQS上で DeleteQueue サービスメソッドを実行するために必要なパラメータ用のコンテナ
      例外:
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### sendMessage

          SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

      パラメータ:
        `sendMessageRequest` - AmazonSQS上で SendMessage サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される SendMessage サービスメソッドからの戻り値
      例外:
        `InvalidMessageContentsException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### receiveMessage

          ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

      パラメータ:
        `receiveMessageRequest` - AmazonSQS上で ReceiveMessage サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される ReceiveMessage サービスメソッドからの戻り値
      例外:
        `OverLimitException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### listQueues

          ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

      パラメータ:
        `listQueuesRequest` - AmazonSQS上で ListQueues サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される ListQueues サービスメソッドからの戻り値
      例外:
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### deleteMessageBatch

          DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

      パラメータ:
        `deleteMessageBatchRequest` - AmazonSQS上で DeleteMessageBatch サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される DeleteMessageBatch サービスメソッドからの戻り値
      例外:
        `BatchEntryIdsNotDistinctException`
        `TooManyEntriesInBatchRequestException`
        `InvalidBatchEntryIdException`
        `EmptyBatchRequestException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### createQueue

          CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

      パラメータ:
        `createQueueRequest` - AmazonSQS上で CreateQueue サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される CreateQueue サービスメソッドからの戻り値
      例外:
        `QueueNameExistsException`
        `QueueDeletedRecentlyException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### addPermission

          void addPermission(AddPermissionRequest addPermissionRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

      パラメータ:
        `addPermissionRequest` - AmazonSQS上で AddPermission サービスメソッドを実行するために必要なパラメータ用のコンテナ
      例外:
        `OverLimitException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### deleteMessage

          void deleteMessage(DeleteMessageRequest deleteMessageRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

      パラメータ:
        `deleteMessageRequest` - AmazonSQS上で DeleteMessage サービスメソッドを実行するために必要なパラメータ用のコンテナ
      例外:
        `ReceiptHandleIsInvalidException`
        `InvalidIdFormatException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### listQueues

          ListQueuesResult listQueues()
                                      throws AmazonServiceException,
                                             AmazonClientException

      戻り値:
        AmazonSQS によって返される ListQueues サービスメソッドからの戻り値
      例外:
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### niftyReceiveAndDeleteMessage

          ReceiveMessageResult niftyReceiveAndDeleteMessage(ReceiveMessageRequest receivMessageRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

      パラメータ:
        `receiveMessageRequest` - AmazonSQS上で NiftyReceiveAndDeleteMessage サービスメソッドを実行するために必要なパラメータ用のコンテナ
      戻り値:
        AmazonSQS によって返される NiftyReceiveAndDeleteMessage サービスメソッドからの戻り値
      例外:
        `OverLimitException`
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合は、AmazonSQS によって返されます。

    - #### niftyGetMetricStatistics

          NiftyGetMetricStatisticsResult niftyGetMetricStatistics(NiftyGetMetricStatisticsRequest niftyGetMetricStatisticsRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

      モニタリング情報を取得します。

      戻り値:
        AmazonSQSによって返されるNiftyGetMetricStatisticsサービスメソッドからの戻り値
      例外:
        `AmazonClientException` - 要求または応答処理しようとした際に、クライアント内部でエラーが発生した場合。（例：ネットワーク接続が利用できない場合）
        `AmazonServiceException` - 要求内のデータまたはサーバー側の問題の場合、AmazonSQS によって返されます。

    - #### shutdown

          void shutdown()

      このクライアントオブジェクトをシャットダウンし、 開いたままである可能性のあるリソースを解放します。 これはオプショナルメソッドであり、明示的にリソースを解放する場合にのみ使用します。 シャットダウン後は、リクエスト要求されるべきではありません。

    - #### getCachedResponseMetadata

          ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

      期待どおりにサービスが動作しない問題をデバッグするため、以前に成功した際のメタデータを返します。 このデータは操作結果としては扱われない為、診断用のインタフェースとして利用できます。

      レスポンス・メタデータは一定期間しかキャッシュされない為、実行結果にアクセスする必要がある場合は このメソッドを使用して、要求後できるだけ早く取得する必要があります。

      パラメータ:
        `request` - 最初に実行された要求
      戻り値:
        指定された要求のレスポンス・メタデータ またはnull