ListPickupLocationsCommand

Suggest an Edit

A list of locations from which the customer can choose to pickup a device.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SnowballClient, ListPickupLocationsCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, ListPickupLocationsCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // ListPickupLocationsRequest
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListPickupLocationsCommand(input);
const response = await client.send(command);
// { // ListPickupLocationsResult
//   Addresses: [ // AddressList
//     { // Address
//       AddressId: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       Company: "STRING_VALUE",
//       Street1: "STRING_VALUE",
//       Street2: "STRING_VALUE",
//       Street3: "STRING_VALUE",
//       City: "STRING_VALUE",
//       StateOrProvince: "STRING_VALUE",
//       PrefectureOrDistrict: "STRING_VALUE",
//       Landmark: "STRING_VALUE",
//       Country: "STRING_VALUE",
//       PostalCode: "STRING_VALUE",
//       PhoneNumber: "STRING_VALUE",
//       IsRestricted: true || false,
//       Type: "CUST_PICKUP" || "AWS_SHIP",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Example Usage

 There was an error loading the code editor. Retry

ListPickupLocationsCommand Input

See ListPickupLocationsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of locations to list per page.

NextToken
string | undefined

HTTP requests are stateless. To identify what object comes "next" in the list of ListPickupLocationsRequest objects, you have the option of specifying NextToken as the starting point for your returned list.

ListPickupLocationsCommand Output

See ListPickupLocationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Addresses
Address[] | undefined

Information about the address of pickup locations.

NextToken
string | undefined

HTTP requests are stateless. To identify what object comes "next" in the list of ListPickupLocationsResult objects, you have the option of specifying NextToken as the starting point for your returned list.

Throws

Name
Fault
Details
InvalidResourceException
client

The specified resource can't be found. Check the information you provided in your last request, and try again.

SnowballServiceException
Base exception class for all service exceptions from Snowball service.