Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1426146126.4 KB

Returns a specified number of <code>ADDRESS</code> objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

post/#X-Amz-Target=AWSIESnowballJobManagementService.DescribeAddresses

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'AWSIESnowballJobManagementService.DescribeAddresses' required

Request body

MaxResultsinteger

The number of <code>ADDRESS</code> objects to return.

NextTokenstring

HTTP requests are stateless. To identify what object comes "next" in the list of <code>ADDRESS</code> objects, you have the option of specifying a value for <code>NextToken</code> as the starting point for your list of returned addresses.

Response

Success

NextTokenstring

HTTP requests are stateless. If you use the automatically generated <code>NextToken</code> value in your next <code>DescribeAddresses</code> call, your list of returned addresses will start from this point in the array.

Example response

{
  "Addresses": [
    {
      "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
      "City": "Seattle",
      "Company": "My Company",
      "Country": "US",
      "Name": "My Name",
      "PhoneNumber": "425-555-5555",
      "PostalCode": "98101",
      "StateOrProvince": "WA",
      "Street1": "123 Main Street"
    }
  ]
}