paws.management (version 0.1.8)

organizations_cancel_handshake: Cancels a handshake

Description

Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED.

Usage

organizations_cancel_handshake(HandshakeId)

Arguments

HandshakeId

[required] The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.

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

Request syntax

svc$cancel_handshake(
  HandshakeId = "string"
)

Details

This operation can be called only from the account that originated the handshake. The recipient of the handshake can\'t cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.

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

Examples

# NOT RUN {
# 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"
)
# }
# NOT RUN {
# }