:doc:`PartnerCentralChannelAPI <../../partnercentral-channel>` / Client / cancel_channel_handshake

************************
cancel_channel_handshake
************************



.. py:method:: PartnerCentralChannelAPI.Client.cancel_channel_handshake(**kwargs)

  

  Cancels a pending channel handshake request.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/partnercentral-channel-2024-03-18/CancelChannelHandshake>`_  


  **Request Syntax**
  ::

    response = client.cancel_channel_handshake(
        catalog='string',
        identifier='string'
    )
    
  :type catalog: string
  :param catalog: **[REQUIRED]** 

    The catalog identifier for the handshake request.

    

  
  :type identifier: string
  :param identifier: **[REQUIRED]** 

    The unique identifier of the channel handshake to cancel.

    

  
  
  :rtype: 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**
  
  *   :py:class:`PartnerCentralChannelAPI.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`PartnerCentralChannelAPI.Client.exceptions.InternalServerException`

  
  *   :py:class:`PartnerCentralChannelAPI.Client.exceptions.ValidationException`

  
  *   :py:class:`PartnerCentralChannelAPI.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PartnerCentralChannelAPI.Client.exceptions.AccessDeniedException`

  