describeHandshake method

Future<DescribeHandshakeResponse> describeHandshake({ required String handshakeId, })

Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.

You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They're then deleted and no longer accessible.

This operation can be called from any account in the organization.

May throw AccessDeniedException. May throw ConcurrentModificationException. May throw HandshakeNotFoundException. May throw InvalidInputException. May throw ServiceException. May throw TooManyRequestsException.

Parameter handshakeId : The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization.

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

Implementation

Future<DescribeHandshakeResponse> describeHandshake({
  required String handshakeId,
}) async {
  ArgumentError.checkNotNull(handshakeId, 'handshakeId');
  _s.validateStringLength(
    'handshakeId',
    handshakeId,
    0,
    34,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSOrganizationsV20161128.DescribeHandshake'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'HandshakeId': handshakeId,
    },
  );

  return DescribeHandshakeResponse.fromJson(jsonResponse.body);
}