PartnerCentralAccountAPI / Client / list_connection_invitations

list_connection_invitations

PartnerCentralAccountAPI.Client.list_connection_invitations(**kwargs)

Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.

See also: AWS API Documentation

Request Syntax

response = client.list_connection_invitations(
    Catalog='string',
    NextToken='string',
    ConnectionType='OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    MaxResults=123,
    OtherParticipantIdentifiers=[
        'string',
    ],
    ParticipantType='SENDER'|'RECEIVER',
    Status='PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED'
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier for the partner account.

• NextToken (string) – The token for retrieving the next page of results in paginated responses.

• ConnectionType (string) – Filter results by connection type (e.g., reseller, distributor, technology partner).

• MaxResults (integer) – The maximum number of connection invitations to return in a single response.

• OtherParticipantIdentifiers (list) –

  Filter results by specific participant identifiers.

  • (string) –

• ParticipantType (string) – Filter results by participant type (inviter or invitee).

• Status (string) – Filter results by invitation status (pending, accepted, rejected, canceled, expired).

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionInvitationSummaries': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ConnectionInvitationSummaries (list) –

    A list of connection invitation summaries matching the specified criteria.

    • (dict) –

      A summary view of a connection invitation containing key information without full details.

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

  • NextToken (string) –

    The token for retrieving the next page of results if more results are available.

Exceptions

• PartnerCentralAccountAPI.Client.exceptions.AccessDeniedException

• PartnerCentralAccountAPI.Client.exceptions.ThrottlingException

• PartnerCentralAccountAPI.Client.exceptions.ValidationException

• PartnerCentralAccountAPI.Client.exceptions.InternalServerException