UpdateSiteAddress - AWS Outposts

UpdateSiteAddress

Updates the site address.

To update a site address with an order IN_PROGRESS, you must wait for the order to complete or cancel the order.

You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

Request Syntax

PUT /sites/SiteId/address HTTP/1.1 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" }

URI Request Parameters

The request uses the following URI parameters.

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 accepts the following data in JSON format.

Address

The address for the site.

Type: Address object

Required: Yes

AddressType

The type of the address.

Type: String

Valid Values: SHIPPING_ADDRESS | OPERATING_ADDRESS

Required: Yes

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" }

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 an address.

Type: Address object

AddressType

The type of the address.

Type: String

Valid Values: SHIPPING_ADDRESS | OPERATING_ADDRESS

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

ConflictException

Updating or deleting this resource can cause an inconsistent state.

HTTP Status Code: 409

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: