ListPickupLocations
Important
End of support notice: On November 12, 2024, AWS will discontinue previous generation AWS Snowball devices, and both Snowcone devices (HDD and SDD). We will continue to support existing customers using these end-of-life devices until November 12, 2025. The latest generation AWS Snowball devices are available for all customers.
For more information, visit this blog post
A list of locations from which the customer can choose to pickup a device.
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 maximum number of locations to list per page.
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
ListPickupLocationsRequest
objects, you have the option of specifyingNextToken
as the starting point for your returned list.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
-
Information about the address of pickup locations.
Type: Array of Address objects
- NextToken
-
HTTP requests are stateless. To identify what object comes "next" in the list of
ListPickupLocationsResult
objects, you have the option of specifyingNextToken
as the starting point for your returned list.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.
- InvalidResourceException
-
The specified resource can't be found. Check the information you provided in your last request, and try again.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ListPickupLocations.
{ "id": "to-get-a-list-of-locations-from-which-the-customer-can-choose-to-pickup-a-device-1482542167627", "title": "To get a list of locations from which the customer can choose to pickup a device.", "description": "Returns a specified number of Address objects. Each Address is a pickup location address for Snowball Edge devices.", "input": {}, "output": { "Addresses": [ { "City": "Seattle", "Name": "My Name", "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", "Street1": "123 Main Street", "Company": "My Company", "PhoneNumber": "425-555-5555", "Country": "US", "PostalCode": "98101", "StateOrProvince": "WA" } ] }, "comments": {} }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: