PartnerCentralChannelAPI / Client / cancel_channel_handshake

cancel_channel_handshake¶

PartnerCentralChannelAPI.Client.cancel_channel_handshake(**kwargs)¶

Cancels a pending channel handshake request.

Request Syntax

response = client.cancel_channel_handshake(
    catalog='string',
    identifier='string'
)

Parameters:

catalog (string) –
[REQUIRED]

The catalog identifier for the handshake request.
identifier (string) –
[REQUIRED]

The unique identifier of the channel handshake to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'channelHandshakeDetail': {
        'id': 'string',
        'arn': 'string',
        'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED'
    }
}

Response Structure

(dict) –
- channelHandshakeDetail (dict) –
  
  Details of the canceled channel handshake.
  - id (string) –
    
    The unique identifier of the canceled handshake.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the canceled handshake.
  - status (string) –
    
    The current status of the canceled handshake.

Exceptions

PartnerCentralChannelAPI.Client.exceptions.ResourceNotFoundException
PartnerCentralChannelAPI.Client.exceptions.InternalServerException
PartnerCentralChannelAPI.Client.exceptions.ValidationException
PartnerCentralChannelAPI.Client.exceptions.ThrottlingException
PartnerCentralChannelAPI.Client.exceptions.AccessDeniedException