DescribeAddresses
Returns a specified number of ADDRESS
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.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The number of
ADDRESS
objects to return.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextToken
-
HTTP requests are stateless. To identify what object comes "next" in the list of
ADDRESS
objects, you have the option of specifying a value forNextToken
as the starting point for your list of returned addresses.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*
Required: No
Response Syntax
{
"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"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Addresses
-
The Snow device shipping addresses that were created for this account.
Type: Array of Address objects
- NextToken
-
HTTP requests are stateless. If you use the automatically generated
NextToken
value in your nextDescribeAddresses
call, your list of returned addresses will start from this point in the array.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextTokenException
-
The
NextToken
string was altered unexpectedly, and the operation has stopped. Run the operation without changing theNextToken
string, and try again.HTTP Status Code: 400
- InvalidResourceException
-
The specified resource can't be found. Check the information you provided in your last request, and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: