PartnerCentralAccountAPI / Client / create_connection_invitation

create_connection_invitation¶

PartnerCentralAccountAPI.Client.create_connection_invitation(**kwargs)¶

Creates a new connection invitation to establish a partnership with another organization.

Request Syntax

response = client.create_connection_invitation(
    Catalog='string',
    ClientToken='string',
    ConnectionType='OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    Email='string',
    Message='string',
    Name='string',
    ReceiverIdentifier='string'
)

Parameters:

Catalog (string) –
[REQUIRED]

The catalog identifier where the connection invitation will be created.
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.
ConnectionType (string) –
[REQUIRED]

The type of connection being requested (e.g., reseller, distributor, technology partner).
Email (string) –
[REQUIRED]

The email address of the person to send the connection invitation to.
Message (string) –
[REQUIRED]

A custom message to include with the connection invitation.
Name (string) –
[REQUIRED]

The name of the person sending the connection invitation.
ReceiverIdentifier (string) –
[REQUIRED]

The identifier of the organization or partner to invite for connection.

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 created.
- Id (string) –
  
  The unique identifier of the created connection invitation.
- Arn (string) –
  
  The Amazon Resource Name (ARN) of the created connection invitation.
- ConnectionId (string) –
  
  The identifier of the connection associated with this invitation.
- ConnectionType (string) –
  
  The type of connection being requested in the invitation.
- CreatedAt (datetime) –
  
  The timestamp when the connection invitation was created.
- UpdatedAt (datetime) –
  
  The timestamp when the connection invitation was last updated.
- ExpiresAt (datetime) –
  
  The timestamp when the connection invitation will expire if not responded to.
- OtherParticipantIdentifier (string) –
  
  The identifier of the organization or partner being invited.
- ParticipantType (string) –
  
  The type of participant (inviter or invitee) in the connection invitation.
- Status (string) –
  
  The current status of the connection invitation (pending, accepted, rejected, etc.).
- InvitationMessage (string) –
  
  The custom message included with the 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