DescribeAddresses - AWS Snowball
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

DescribeAddresses

指定された数の ADDRESS オブジェクトを返します。米国リージョンのいずれかでこの API を呼び出すと、すべての米国リージョンのこのアカウントに関連付けられているすべての住所のリストから住所が返されます。

リクエストの構文

{
   "MaxResults": number,
   "NextToken": "string"
}

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下の JSON 形式のデータを受け入れます。

MaxResults

返される ADDRESS オブジェクトの数。

型: 整数

有効な範囲: 最小値 は 0 です。最大値は 100 です。

必須: いいえ

NextToken

HTTP リクエストはステートレスです。ADDRESS オブジェクトのリストで「次」になるオブジェクトを特定するには、返された住所のリストの開始点としてNextToken に値を指定するオプションがあります。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 1,024 です。

パターン: .*

必須: いいえ

レスポンスの構文

{
   "Addresses": [ 
      { 
         "AddressId": "string",
         "City": "string",
         "Company": "string",
         "Country": "string",
         "IsRestricted": boolean,
         "Landmark": "string",
         "Name": "string",
         "PhoneNumber": "string",
         "PostalCode": "string",
         "PrefectureOrDistrict": "string",
         "StateOrProvince": "string",
         "Street1": "string",
         "Street2": "string",
         "Street3": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

Addresses

このアカウント用に作成された Snow デバイスの配送先住所。

型: Address オブジェクトの配列

NextToken

HTTP リクエストはステートレスです。自動生成されたNextToken 値を次の DescribeAddresses の呼び出しに使用する場合、返される住所のリストは、配列内のこの時点から開始されます。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 1,024 です。

パターン: .*

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InvalidNextTokenException

NextToken 文字列が予期せず変更され、操作が停止しました。NextToken 文字列を変更せずに操作を実行し、再度お試しください。

HTTP ステータスコード：400

InvalidResourceException

指定されたリソースが見つかりません。前回のリクエストで入力した情報をチェックし、もう一度お試しください。

HTTP ステータスコード：400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。