PartnerCentralAccountAPI / Paginator / ListConnectionInvitations

ListConnectionInvitations

class PartnerCentralAccountAPI.Paginator.ListConnectionInvitations

paginator = client.get_paginator('list_connection_invitations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PartnerCentralAccountAPI.Client.list_connection_invitations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    ConnectionType='OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    OtherParticipantIdentifiers=[
        'string',
    ],
    ParticipantType='SENDER'|'RECEIVER',
    Status='PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier for the partner account.

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

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.