DescribeAddressCommand

Suggest an Edit

Takes an AddressId and returns specific details about that address in the form of an Address object.

Example Syntax

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

import { SnowballClient, DescribeAddressCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, DescribeAddressCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // DescribeAddressRequest
  AddressId: "STRING_VALUE", // required
};
const command = new DescribeAddressCommand(input);
const response = await client.send(command);
// { // DescribeAddressResult
//   Address: { // 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",
//   },
// };

Example Usage

 Loading code editor

DescribeAddressCommand Input

See DescribeAddressCommandInput for more details

Parameter
Type
Description
AddressId
Required
string | undefined

The automatically generated ID for a specific address.

DescribeAddressCommand Output

See DescribeAddressCommandOutput for details

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

The address that you want the Snow device(s) associated with a specific job to be shipped to.

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.