Cancels a Handshake¶

Description¶

Cancels a Handshake.

Only the account that sent a handshake can call this operation. The recipient of the handshake can't cancel it, but can use decline_handshake to decline. After a handshake is canceled, the recipient can no longer respond to the handshake.

You can view canceled handshakes in API responses for 30 days before they are deleted.

Usage¶

organizations_cancel_handshake(HandshakeId)

Arguments¶

HandshakeId

[required] ID for the handshake that you want to cancel. You can get the ID from the list_handshakes_for_organization operation.

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$cancel_handshake(
  HandshakeId = "string"
)

Examples¶

# Bill previously sent an invitation to Susan's account to join his
# organization. He changes his mind and decides to cancel the invitation
# before Susan accepts it. The following example shows Bill's
# cancellation:
# 
svc$cancel_handshake(
  HandshakeId = "h-examplehandshakeid111"
)