PartnerCentralAccountAPI / Client / cancel_connection_invitation

cancel_connection_invitation¶

PartnerCentralAccountAPI.Client.cancel_connection_invitation(**kwargs)¶

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

Request Syntax

response = client.cancel_connection_invitation(
    Catalog='string',
    Identifier='string',
    ClientToken='string'
)

Parameters:

Catalog (string) –
[REQUIRED]

The catalog identifier where the connection invitation exists.
Identifier (string) –
[REQUIRED]

The unique identifier of the connection invitation to cancel.
ClientToken (string) –
[REQUIRED]

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

This field is autopopulated if not provided.

Return type:

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

PartnerCentralAccountAPI.Client.exceptions.ResourceNotFoundException
PartnerCentralAccountAPI.Client.exceptions.AccessDeniedException
PartnerCentralAccountAPI.Client.exceptions.ThrottlingException
PartnerCentralAccountAPI.Client.exceptions.ConflictException
PartnerCentralAccountAPI.Client.exceptions.ValidationException
PartnerCentralAccountAPI.Client.exceptions.InternalServerException