[ aws . outposts ]

update-site-address

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-site-address
--site-id <value>
--address-type <value>
--address <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--site-id (string)

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

Note

In requests, Amazon Web Services 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.

--address-type (string)

The type of the address.

Possible values:

• SHIPPING_ADDRESS

• OPERATING_ADDRESS

--address (structure)

The address for the site.

ContactName -> (string)

The name of the contact.

ContactPhoneNumber -> (string)

The phone number of the contact.

AddressLine1 -> (string)

The first line of the address.

AddressLine2 -> (string)

The second line of the address.

AddressLine3 -> (string)

The third line of the address.

City -> (string)

The city for the address.

StateOrRegion -> (string)

The state for the address.

DistrictOrCounty -> (string)

The district or county for the address.

PostalCode -> (string)

The postal code for the address.

CountryCode -> (string)

The ISO-3166 two-letter country code for the address.

Municipality -> (string)

The municipality for the address.

Shorthand Syntax:

ContactName=string,ContactPhoneNumber=string,AddressLine1=string,AddressLine2=string,AddressLine3=string,City=string,StateOrRegion=string,DistrictOrCounty=string,PostalCode=string,CountryCode=string,Municipality=string

JSON Syntax:

{
  "ContactName": "string",
  "ContactPhoneNumber": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "AddressLine3": "string",
  "City": "string",
  "StateOrRegion": "string",
  "DistrictOrCounty": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Municipality": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

AddressType -> (string)

The type of the address.

Address -> (structure)

Information about an address.

ContactName -> (string)

The name of the contact.

ContactPhoneNumber -> (string)

The phone number of the contact.

AddressLine1 -> (string)

The first line of the address.

AddressLine2 -> (string)

The second line of the address.

AddressLine3 -> (string)

The third line of the address.

City -> (string)

The city for the address.

StateOrRegion -> (string)

The state for the address.

DistrictOrCounty -> (string)

The district or county for the address.

PostalCode -> (string)

The postal code for the address.

CountryCode -> (string)

The ISO-3166 two-letter country code for the address.

Municipality -> (string)

The municipality for the address.