UpdateSiteAddressCommand

Suggest an Edit

Updates the address of the specified site.

You can't update a site address if there is 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.

Example Syntax

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

import { OutpostsClient, UpdateSiteAddressCommand } from "@aws-sdk/client-outposts"; // ES Modules import
// const { OutpostsClient, UpdateSiteAddressCommand } = require("@aws-sdk/client-outposts"); // CommonJS import
const client = new OutpostsClient(config);
const input = { // UpdateSiteAddressInput
  SiteId: "STRING_VALUE", // required
  AddressType: "SHIPPING_ADDRESS" || "OPERATING_ADDRESS", // required
  Address: { // Address
    ContactName: "STRING_VALUE",
    ContactPhoneNumber: "STRING_VALUE",
    AddressLine1: "STRING_VALUE", // required
    AddressLine2: "STRING_VALUE",
    AddressLine3: "STRING_VALUE",
    City: "STRING_VALUE", // required
    StateOrRegion: "STRING_VALUE", // required
    DistrictOrCounty: "STRING_VALUE",
    PostalCode: "STRING_VALUE", // required
    CountryCode: "STRING_VALUE", // required
    Municipality: "STRING_VALUE",
  },
};
const command = new UpdateSiteAddressCommand(input);
const response = await client.send(command);
// { // UpdateSiteAddressOutput
//   AddressType: "SHIPPING_ADDRESS" || "OPERATING_ADDRESS",
//   Address: { // Address
//     ContactName: "STRING_VALUE",
//     ContactPhoneNumber: "STRING_VALUE",
//     AddressLine1: "STRING_VALUE", // required
//     AddressLine2: "STRING_VALUE",
//     AddressLine3: "STRING_VALUE",
//     City: "STRING_VALUE", // required
//     StateOrRegion: "STRING_VALUE", // required
//     DistrictOrCounty: "STRING_VALUE",
//     PostalCode: "STRING_VALUE", // required
//     CountryCode: "STRING_VALUE", // required
//     Municipality: "STRING_VALUE",
//   },
// };

UpdateSiteAddressCommand Input

See UpdateSiteAddressCommandInput for more details

Parameter
Type
Description
Address
Required
Address | undefined

The address for the site.

AddressType
Required
AddressType | undefined

The type of the address.

SiteId
Required
string | undefined

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

UpdateSiteAddressCommand Output

See UpdateSiteAddressCommandOutput for details

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

Information about an address.

AddressType
AddressType | undefined

The type of the address.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have permission to perform this operation.

ConflictException
client

Updating or deleting this resource can cause an inconsistent state.

InternalServerException
server

An internal error has occurred.

NotFoundException
client

The specified request is not valid.

ValidationException
client

A parameter is not valid.

OutpostsServiceException
Base exception class for all service exceptions from Outposts service.