PartnerCentralAccountAPI / Client / get_connection_invitation

get_connection_invitation

PartnerCentralAccountAPI.Client.get_connection_invitation(**kwargs)

Retrieves detailed information about a specific connection invitation.

See also: AWS API Documentation

Request Syntax

response = client.get_connection_invitation(
    Catalog='string',
    Identifier='string'
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier where the connection invitation exists.

• Identifier (string) –

  [REQUIRED]

  The unique identifier of the connection invitation to retrieve.

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 exists.

  • Id (string) –

    The unique identifier of the connection invitation.

  • Arn (string) –

    The Amazon Resource Name (ARN) of the 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.

  • OtherParticipantIdentifier (string) –

    The identifier of the other participant in the connection invitation.

  • ParticipantType (string) –

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

  • Status (string) –

    The current status of the connection invitation.

  • 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.ValidationException

• PartnerCentralAccountAPI.Client.exceptions.InternalServerException