com.amazonaws

## クラス AmazonWebServiceClient

- java.lang.Object
- - com.amazonaws.AmazonWebServiceClient

- 直系の既知のサブクラス:
    AmazonAutoScalingClient, AmazonCloudFormationClient, AmazonCloudFrontClient, AmazonCloudFrontClient, AmazonCloudSearchClient, AmazonCloudWatchClient, AmazonDirectConnectClient, AmazonDynamoDBClient, AmazonDynamoDBClient, AmazonEC2Client, AmazonElastiCacheClient, AmazonElasticLoadBalancingClient, AmazonElasticMapReduceClient, AmazonElasticTranscoderClient, AmazonGlacierClient, AmazonIdentityManagementClient, AmazonImportExportClient, AmazonRDSClient, AmazonRedshiftClient, AmazonRoute53Client, AmazonS3Client, AmazonSimpleDBClient, AmazonSimpleEmailServiceClient, AmazonSimpleWorkflowClient, AmazonSNSClient, AmazonSQSClient, AWSElasticBeanstalkClient, AWSOpsWorksClient, AWSSecurityTokenServiceClient, AWSStorageGatewayClient, AWSSupportClient, DataPipelineClient

      public abstract class AmazonWebServiceClient
      extends java.lang.Object

  Amazon Web Service の Java クライアントの抽象ベースクラスです。

  すべての AWS SDK Java クライアントで共通する基本的なクライアントの要素・機能 (例: クライアントエンドポイントなどをセットします) を保持します。

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected AmazonHttpClient` | `client` AWS サービスへのリクエストを送信するための低レベルのクライアント
    `protected ClientConfiguration` | `clientConfiguration` クライアントの設定
    `protected java.net.URI` | `endpoint` このクライアントがリクエストを送信するサービスのエンドポイント
    `protected java.util.List<RequestHandler>` | `requestHandlers` 追加でリクエスト処理を行うためのオプションリクエストハンドラ
    `protected int` | `timeOffset` リクエストを署名するときに利用するオフセット (秒数)
    `protected java.lang.String` | `version` このクライアントが利用するAPIのバージョン

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `AmazonWebServiceClient(ClientConfiguration clientConfiguration)` 設定を指定した AmazonWebServiceClient のコンストラクタです。

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addRequestHandler(RequestHandler requestHandler)` リクエストのライフサイクルの一環で実行される登録されたハンドラのリストに リクエストハンドラを追加します。
    `protected <T> HttpRequest` | `convertToHttpRequest(Request<T> request, HttpMethodName methodName)` 非推奨です。
    `protected ExecutionContext` | `createExecutionContext()`
    `protected java.lang.String` | `getServiceAbbreviation()` リージョンによるサービスエンドポイントを特定するために、このサービスに対する 略称を返します
    `int` | `getTimeOffset()` このクライアントのタイムオフセットに対してオプショナルな値を返します。
    `java.lang.String` | `getVersion()` このクライアントに対するデフォルトのバージョンを取得します。
    `void` | `removeRequestHandler(RequestHandler requestHandler)` リクエストのライフサイクルの一環で実行される登録されたハンドラのリストからハンドラを 削除します。
    `void` | `setConfiguration(ClientConfiguration clientConfiguration)`
    `void` | `setEndpoint(java.lang.String endpoint)` このクライアントに対するデフォルトのエンドポイントを上書きします。
    `void` | `setRegion(Region region)` `setEndpoint(String)` の代わりに、クライアントの サービスコールに利用するリージョンのエンドポイントをセットします。
    `void` | `setTimeOffset(int timeOffset)` このクライアントのタイムオフセットに対してオプショナルな値をセットします。
    `void` | `setVersion(java.lang.String version)` このクライアントに対するデフォルトのバージョンを指定します。
    `void` | `shutdown()` オープン状態を保持されていたリソースを開放するときに、 このクライアントオブジェクトを終了します。
    `AmazonWebServiceClient` | `withTimeOffset(int timeOffset)` このクライアントのタイムオフセットに対してオプショナルな値をセットします。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### endpoint

          protected java.net.URI endpoint

      このクライアントがリクエストを送信するサービスのエンドポイント

    - #### clientConfiguration

          protected ClientConfiguration clientConfiguration

      クライアントの設定

    - #### client

          protected AmazonHttpClient client

      AWS サービスへのリクエストを送信するための低レベルのクライアント

    - #### requestHandlers

          protected final java.util.List<RequestHandler> requestHandlers

      追加でリクエスト処理を行うためのオプションリクエストハンドラ

    - #### timeOffset

          protected int timeOffset

      リクエストを署名するときに利用するオフセット (秒数)

    - #### version

          protected java.lang.String version

      このクライアントが利用するAPIのバージョン

  - ### コンストラクタの詳細

    - #### AmazonWebServiceClient

          public AmazonWebServiceClient(ClientConfiguration clientConfiguration)

      設定を指定した AmazonWebServiceClient のコンストラクタです。
      パラメータ:
        `clientConfiguration` - このクライアントの設定

  - ### メソッドの詳細

    - #### setEndpoint

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

      このクライアントに対するデフォルトのエンドポイントを上書きします。呼び出し側は どの AWS リージョンで処理を実行するかをコントロールすうるためにこのメソッドを 利用します。

      このメソッドはスレッドセーフではありません。エンドポイントはサービスリクエストを 生成する前、クライアントが生成されるときに設定されるべきです。 その後にエンドポイントを変更することで、送信時にサービスリクエスト間で競合状態を 発生させます。

      (メソッドを実行すると)すぐにエンドポイント (例: "ec2.amazonaws.com") または プロトコルを含むフル URL (例: "https://ec2.amazonaws.com") を渡すことができます。 もしここでプロトコルが指定されていなければクライアントの `ClientConfiguration` からデフォルトのプロトコルである HTTPS が利用されます。

      AWS SDK for Java で利用できる AWS リージョンについてのより詳細な情報および すべての AWS サービスで利用できるすべてのエンドポイントについてのリストは http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912 を御覧ください

      パラメータ:
        `endpoint` - このクライアントが通信するリージョンの AWS のエンドポイント (例: "ec2.amazonaws.com") またはプロトコルを含む完全な URL (ex: "https://ec2.amazonaws.com") 。
      例外:
        `java.lang.IllegalArgumentException` - 指定したエンドポイントで発見された問題

    - #### setVersion

          public void setVersion(java.lang.String version)

      このクライアントに対するデフォルトのバージョンを指定します。
      パラメータ:
        `version` - このクライアントが通信するAPIのバージョン

    - #### getVersion

          public java.lang.String getVersion()

      このクライアントに対するデフォルトのバージョンを取得します。
      戻り値:
        version このクライアントが通信するAPIのバージョン

    - #### setRegion

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

      `setEndpoint(String)` の代わりに、クライアントの サービスコールに利用するリージョンのエンドポイントをセットします。 呼び出し側は処理を実行させたい AWS リージョンの制御にこのメソッドを利用することができます。

      このメソッドはスレッドセーフではありません。エンドポイントはサービスリクエストを 生成する前、クライアントが生成されるときに設定されるべきです。 その後にエンドポイントを変更することで、送信時または再送時にサービスリクエスト間で 競合状態を発生させます。

      デフォルトではすべてのリージョンのすべてのサービスのエンドポイントは https プロトコルを利用します。 https の代わりに http を利用するためには、 コンストラクタに渡される `ClientConfiguration` に http を指定してください。

      パラメータ:
        `region` - このクライアントが通信しようとするリージョン リージョンについては `Region.getRegion(com.amazonaws.regions.Regions)` を参照してください。
      例外:
        `java.lang.IllegalArgumentException` - 与えられたリージョンが null の場合やサービスが与えられたリージョンを 利用できない場合にスローされます `Region.isServiceSupported(String)` を参照してください。
      関連項目:
        `Region.getRegion(com.amazonaws.regions.Regions)`, `Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)`

    - #### getServiceAbbreviation

          protected java.lang.String getServiceAbbreviation()

      リージョンによるサービスエンドポイントを特定するために、このサービスに対する 略称を返します
      関連項目:
        `ServiceAbbreviations`

    - #### setConfiguration

          public void setConfiguration(ClientConfiguration clientConfiguration)

    - #### shutdown

          public void shutdown()

      オープン状態を保持されていたリソースを開放するときに、 このクライアントオブジェクトを終了します。これはオプショナルなメソッドで、 このメソッドを必ずしも呼び出す必要はありませんが、リソースを開放するために明示的に 呼び出したいときに利用できます。一度クライアントが終了されると、リクエストを 生成するために利用すべきではありません。

    - #### convertToHttpRequest

          @Deprecated
          protected <T> HttpRequest convertToHttpRequest(Request<T> request,
                                                        HttpMethodName methodName)

      非推奨です。
      あるリクエスト オブジェクトを HttpRequest オブジェクトに変換します。 すべてのヘッダ、パラメタなどはこのリクエストから新しい HttpRequest にコピーされます。
      パラメータ:
        `request` - コンバートしたいリクエスト
        `methodName` - 変換後の HttpRequest オブジェクトで利用される HTTP メソッド (GET, PUT, DELETE, HEAD)
      戻り値:
        指定されたリクエスト オブジェクトの詳細情報から作られた新しい HttpRequest オブジェクト

    - #### addRequestHandler

          public void addRequestHandler(RequestHandler requestHandler)

      リクエストのライフサイクルの一環で実行される登録されたハンドラのリストに リクエストハンドラを追加します。
      パラメータ:
        `requestHandler` - リクエストハンドラの現時点でのリストに追加したい新しいハンドラ

    - #### removeRequestHandler

          public void removeRequestHandler(RequestHandler requestHandler)

      リクエストのライフサイクルの一環で実行される登録されたハンドラのリストからハンドラを 削除します。
      パラメータ:
        `requestHandler` - リクエストハンドラの現時点でのリストから削除されるハンドラ

    - #### createExecutionContext

          protected ExecutionContext createExecutionContext()

    - #### setTimeOffset

          public void setTimeOffset(int timeOffset)

      このクライアントのタイムオフセットに対してオプショナルな値をセットします。 この値は、このクライアントを通して処理されるすべてのリクエストに適用されます。 値は秒数で、正の値は現時刻に対して"早い"ことを、負の値は遅いことを意味します。
      パラメータ:
        `timeOffset` - このクライアントのタイムオフセット (秒数) に対するオプショナルな値

    - #### withTimeOffset

          public AmazonWebServiceClient withTimeOffset(int timeOffset)

      このクライアントのタイムオフセットに対してオプショナルな値をセットします。 この値は、このクライアントを通して処理されるすべてのリクエストに適用されます。 値は秒数で、正の値は現時刻に対して"早い"ことを、負の値は遅いことを意味します。
      パラメータ:
        `timeOffset` - このクライアントのタイムオフセット (秒数) に対するオプショナルな値
      戻り値:
        更新された Web サービスクライアント

    - #### getTimeOffset

          public int getTimeOffset()

      このクライアントのタイムオフセットに対してオプショナルな値を返します。 この値は、このクライアントを通して処理されるすべてのリクエストに適用されます。 値は秒数で、正の値は現時刻に対して"早い"ことを、負の値は遅いことを意味します。
      戻り値:
        このクライアントのタイムオフセット (秒数) に対するオプショナルな値