Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AcceptHandshakeCommand

Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.

You can only call this operation by the following principals when they also have the relevant IAM permissions:

  • Invitation to join or Approve all features request handshakes: only a principal from the member account.

    The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, the user must also have the iam:CreateServiceLinkedRole permission so that Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and Service-Linked Roles in the Organizations User Guide.

  • Enable all features final confirmation handshake: only a principal from the management account.

    For more information about invitations, see Inviting an Amazon Web Services account to join your organization in the Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling all features in your organization in the Organizations User Guide.

After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.

example

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

import { OrganizationsClient, AcceptHandshakeCommand } from "@aws-sdk/client-organizations"; // ES Modules import
// const { OrganizationsClient, AcceptHandshakeCommand } = require("@aws-sdk/client-organizations"); // CommonJS import
const client = new OrganizationsClient(config);
const command = new AcceptHandshakeCommand(input);
const response = await client.send(command);
see

AcceptHandshakeCommandInput for command's input shape.

see

AcceptHandshakeCommandOutput for command's response shape.

see

config for OrganizationsClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: AcceptHandshakeCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<AcceptHandshakeCommandInput, AcceptHandshakeCommandOutput>

Methods

Static getEndpointParameterInstructions