Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeAddress

Note

Amazon Snowball Edge is no longer available to new customers. New customers should explore Amazon DataSync for online transfers, Amazon Data Transfer Terminal for secure physical transfers, or Amazon Partner solutions. For edge computing, explore Amazon Outposts.

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

Request Syntax


{
   "AddressId": "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.

AddressId

The automatically generated ID for a specific address.

Type: String

Length Constraints: Fixed length of 40.

Pattern: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Response Syntax


{
   "Address": { 
      "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"
   }
}

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.

Address

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

Type: Address object

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.

ResourceType: The provided resource value is invalid.

HTTP Status Code: 400