Skip to content

Accept Handshake

organizations_accept_handshake R Documentation

Accepts a handshake by sending an ACCEPTED response to the sender

Description

Accepts a handshake by sending an ACCEPTED response to the sender. You can view accepted handshakes in API responses for 30 days before they are deleted.

Only the management account can accept the following handshakes:

  • Enable all features final confirmation (APPROVE_ALL_FEATURES)

  • Billing transfer (TRANSFER_RESPONSIBILITY)

For more information, see Enabling all features and Responding to a billing transfer invitation in the Organizations User Guide.

Only a member account can accept the following handshakes:

  • Invitation to join (INVITE)

  • Approve all features request (ENABLE_ALL_FEATURES)

For more information, see Responding to invitations and Enabling all features in the Organizations User Guide.

When a handshake is accepted, Organizations logs membership events in CloudTrail, available only in the management account's event history. If the account was standalone and joined a new organization, an AccountJoinedOrganization event is logged with joinedMethod:Invited and joinedTime fields. If the account departed one organization and joined another, both an AccountDepartedOrganization event with departedMethod:Left and departedTime and an AccountJoinedOrganization event with joinedMethod:Invited and joinedTime are logged in their respective management accounts.

Usage

organizations_accept_handshake(HandshakeId)

Arguments

HandshakeId

[required] ID for the handshake that you want to accept.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

Value

A list with the following syntax:

list(
  Handshake = list(
    Id = "string",
    Arn = "string",
    Parties = list(
      list(
        Id = "string",
        Type = "ACCOUNT"|"ORGANIZATION"|"EMAIL"
      )
    ),
    State = "REQUESTED"|"OPEN"|"CANCELED"|"ACCEPTED"|"DECLINED"|"EXPIRED",
    RequestedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    ExpirationTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Action = "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"|"TRANSFER_RESPONSIBILITY",
    Resources = list(
      list(
        Value = "string",
        Type = "ACCOUNT"|"ORGANIZATION"|"ORGANIZATION_FEATURE_SET"|"EMAIL"|"MASTER_EMAIL"|"MASTER_NAME"|"NOTES"|"PARENT_HANDSHAKE"|"RESPONSIBILITY_TRANSFER"|"TRANSFER_START_TIMESTAMP"|"TRANSFER_TYPE"|"MANAGEMENT_ACCOUNT"|"MANAGEMENT_EMAIL"|"MANAGEMENT_NAME",
        Resources = list()
      )
    )
  )
)

Request syntax

svc$accept_handshake(
  HandshakeId = "string"
)

Examples

## Not run: 
# Bill is the owner of an organization, and he invites Juan's account
# (222222222222) to join his organization. The following example shows
# Juan's account accepting the handshake and thus agreeing to the
# invitation.
svc$accept_handshake(
  HandshakeId = "h-examplehandshakeid111"
)

## End(Not run)