Describe Handshake

organizations_describe_handshake

R Documentation

Returns details for a handshake

Description

Returns details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient.

You can view ACCEPTED, DECLINED, or CANCELED handshakes in API Responses for 30 days before they are deleted.

You can call this operation from any account in a organization.

Usage

organizations_describe_handshake(HandshakeId)

Arguments

HandshakeId

[required] ID for the handshake that you want information about. 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$describe_handshake(
  HandshakeId = "string"
)

Examples

## Not run: 
# The following example shows you how to request details about a
# handshake. The handshake ID comes either from the original call to
# "InviteAccountToOrganization", or from a call to
# "ListHandshakesForAccount" or "ListHandshakesForOrganization":
svc$describe_handshake(
  HandshakeId = "h-examplehandshakeid111"
)

## End(Not run)