:doc:`PartnerCentralAccountAPI <../../partnercentral-account>` / Client / cancel_connection_invitation

****************************
cancel_connection_invitation
****************************



.. py:method:: PartnerCentralAccountAPI.Client.cancel_connection_invitation(**kwargs)

  

  Cancels a pending connection invitation before it has been accepted or rejected.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/partnercentral-account-2025-04-04/CancelConnectionInvitation>`_  


  **Request Syntax**
  ::

    response = client.cancel_connection_invitation(
        Catalog='string',
        Identifier='string',
        ClientToken='string'
    )
    
  :type Catalog: string
  :param Catalog: **[REQUIRED]** 

    The catalog identifier where the connection invitation exists.

    

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

    The unique identifier of the connection invitation to cancel.

    

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Catalog': 'string',
          'Id': 'string',
          'Arn': 'string',
          'ConnectionId': 'string',
          'ConnectionType': 'OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
          'CreatedAt': datetime(2015, 1, 1),
          'UpdatedAt': datetime(2015, 1, 1),
          'ExpiresAt': datetime(2015, 1, 1),
          'OtherParticipantIdentifier': 'string',
          'ParticipantType': 'SENDER'|'RECEIVER',
          'Status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED',
          'InvitationMessage': 'string',
          'InviterEmail': 'string',
          'InviterName': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Catalog** *(string) --* 

        The catalog identifier where the connection invitation was canceled.

        
      

      - **Id** *(string) --* 

        The unique identifier of the canceled connection invitation.

        
      

      - **Arn** *(string) --* 

        The Amazon Resource Name (ARN) of the canceled connection invitation.

        
      

      - **ConnectionId** *(string) --* 

        The identifier of the connection associated with the canceled invitation.

        
      

      - **ConnectionType** *(string) --* 

        The type of connection that was being invited for.

        
      

      - **CreatedAt** *(datetime) --* 

        The timestamp when the connection invitation was originally created.

        
      

      - **UpdatedAt** *(datetime) --* 

        The timestamp when the connection invitation was last updated (canceled).

        
      

      - **ExpiresAt** *(datetime) --* 

        The timestamp when the connection invitation would have expired if not canceled.

        
      

      - **OtherParticipantIdentifier** *(string) --* 

        The identifier of the other participant who was invited to connect.

        
      

      - **ParticipantType** *(string) --* 

        The type of participant (inviter or invitee) in the connection invitation.

        
      

      - **Status** *(string) --* 

        The current status of the connection invitation (canceled).

        
      

      - **InvitationMessage** *(string) --* 

        The message that was included with the original connection invitation.

        
      

      - **InviterEmail** *(string) --* 

        The email address of the person who sent the connection invitation.

        
      

      - **InviterName** *(string) --* 

        The name of the person who sent the connection invitation.

        
  
  **Exceptions**
  
  *   :py:class:`PartnerCentralAccountAPI.Client.exceptions.ResourceNotFoundException`

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

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

  
  *   :py:class:`PartnerCentralAccountAPI.Client.exceptions.ConflictException`

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

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

  