- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
PutAlternateContactCommand
Modifies the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts .
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AccountClient, PutAlternateContactCommand } from "@aws-sdk/client-account"; // ES Modules import
// const { AccountClient, PutAlternateContactCommand } = require("@aws-sdk/client-account"); // CommonJS import
const client = new AccountClient(config);
const input = { // PutAlternateContactRequest
Name: "STRING_VALUE", // required
Title: "STRING_VALUE", // required
EmailAddress: "STRING_VALUE", // required
PhoneNumber: "STRING_VALUE", // required
AlternateContactType: "STRING_VALUE", // required
AccountId: "STRING_VALUE",
};
const command = new PutAlternateContactCommand(input);
const response = await client.send(command);
// {};
PutAlternateContactCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AlternateContactType Required | AlternateContactType | undefined | Specifies which alternate contact you want to create or update. |
EmailAddress Required | string | undefined | Specifies an email address for the alternate contact. |
Name Required | string | undefined | Specifies a name for the alternate contact. |
PhoneNumber Required | string | undefined | Specifies a phone number for the alternate contact. |
Title Required | string | undefined | Specifies a title for the alternate contact. |
AccountId | string | undefined | Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled , and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned. The management account can't specify its own To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify. |
PutAlternateContactCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The operation failed because the calling identity doesn't have the minimum required permissions. |
InternalServerException | server | The operation failed because of an error internal to Amazon Web Services. Try your operation again later. |
TooManyRequestsException | client | The operation failed because it was called too frequently and exceeded a throttle limit. |
ValidationException | client | The operation failed because one of the input parameters was invalid. |
AccountServiceException | Base exception class for all service exceptions from Account service. |