PartnerCentralSellingAPI / Paginator / ListEngagements

ListEngagements

class PartnerCentralSellingAPI.Paginator.ListEngagements

paginator = client.get_paginator('list_engagements')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    CreatedBy=[
        'string',
    ],
    ExcludeCreatedBy=[
        'string',
    ],
    ContextTypes=[
        'CustomerProject'|'Lead',
    ],
    ExcludeContextTypes=[
        'CustomerProject'|'Lead',
    ],
    Sort={
        'SortOrder': 'ASCENDING'|'DESCENDING',
        'SortBy': 'CreatedDate'
    },
    EngagementIdentifier=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  Specifies the catalog related to the request.

• CreatedBy (list) –

  A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

  • (string) –

• ExcludeCreatedBy (list) –

  An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

  • (string) –

• ContextTypes (list) –

  Filters engagements to include only those containing the specified context types, such as “CustomerProject” or “Lead”. Use this to find engagements that have specific types of contextual information associated with them.

  • (string) –

• ExcludeContextTypes (list) –

  Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.

  • (string) –

• Sort (dict) –

  Specifies the sorting parameters for listing Engagements.

  • SortOrder (string) – [REQUIRED]

    The order in which to sort the results.

  • SortBy (string) – [REQUIRED]

    The field by which to sort the results.

• EngagementIdentifier (list) –

  An array of strings representing engagement identifiers to retrieve.

  • (string) –

• 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

{
    'EngagementSummaryList': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Title': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'MemberCount': 123,
            'ModifiedAt': datetime(2015, 1, 1),
            'ModifiedBy': 'string',
            'ContextTypes': [
                'CustomerProject'|'Lead',
            ]
        },
    ],

}

Response Structure

• (dict) –

  • EngagementSummaryList (list) –

    An array of engagement summary objects.

    • (dict) –

      An object that contains an Engagement’s subset of fields.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the created Engagement.

      • Id (string) –

        The unique identifier for the Engagement.

      • Title (string) –

        The title of the Engagement.

      • CreatedAt (datetime) –

        The date and time when the Engagement was created.

      • CreatedBy (string) –

        The AWS Account ID of the Engagement creator.

      • MemberCount (integer) –

        The number of members in the Engagement.

      • ModifiedAt (datetime) –

        The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: “2023-05-01T20:37:46Z”.

      • ModifiedBy (string) –

        The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.

      • ContextTypes (list) –

        An array of context types associated with the engagement, such as “CustomerProject” or “Lead”. This provides a quick overview of the types of contexts included in the engagement.

        • (string) –