PartnerCentralSellingAPI / Paginator / ListEngagementMembers

ListEngagementMembers

class PartnerCentralSellingAPI.Paginator.ListEngagementMembers

paginator = client.get_paginator('list_engagement_members')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PartnerCentralSellingAPI.Client.list_engagement_members().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    Identifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog related to the request.

• Identifier (string) –

  [REQUIRED]

  Identifier of the Engagement record to retrieve members from.

• 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

{
    'EngagementMemberList': [
        {
            'AccountId': 'string',
            'CompanyName': 'string',
            'WebsiteUrl': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • EngagementMemberList (list) –

    Provides a list of engagement members.

    • (dict) –

      Engagement members are the participants in an Engagement, which is likely a collaborative project or business opportunity within the AWS partner network. Members can be different partner organizations or AWS accounts that are working together on a specific engagement.

      Each member is represented by their AWS Account ID, Company Name, and associated details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current state of participation. Only existing members of an Engagement can view the list of other members. This implies a level of privacy and access control within the Engagement structure.

      • AccountId (string) –

        This is the unique identifier for the AWS account associated with the member organization. It’s used for AWS-related operations and identity verification.

      • CompanyName (string) –

        The official name of the member’s company or organization.

      • WebsiteUrl (string) –

        The URL of the member company’s website. This offers a way to find more information about the member organization and serves as an additional identifier.