GetSiteAddress - AWS Outposts

GetSiteAddress

Gets the site address.

Request Syntax

GET /sites/SiteId/address?AddressType=AddressType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AddressType

The type of the address you request.

Valid Values: SHIPPING_ADDRESS | OPERATING_ADDRESS

Required: Yes

SiteId

The ID or the Amazon Resource Name (ARN) of the site.

Note

In requests, AWS Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and sites throughout the Outposts Query API. To address backwards compatibility, the parameter names OutpostID or SiteID remain in use. Despite the parameter name, you can make the request with an ARN.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Address": { "AddressLine1": "string", "AddressLine2": "string", "AddressLine3": "string", "City": "string", "ContactName": "string", "ContactPhoneNumber": "string", "CountryCode": "string", "DistrictOrCounty": "string", "Municipality": "string", "PostalCode": "string", "StateOrRegion": "string" }, "AddressType": "string", "SiteId": "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

Information about the address.

Type: Address object

AddressType

The type of the address you receive.

Type: String

Valid Values: SHIPPING_ADDRESS | OPERATING_ADDRESS

SiteId

The ID of the site.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]{17})$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

NotFoundException

The specified request is not valid.

HTTP Status Code: 404

ValidationException

A parameter is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: