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',
    ],
    EngagementIdentifier=[
        'string',
    ],
    ExcludeCreatedBy=[
        'string',
    ],
    Sort={
        'SortBy': 'CreatedDate',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    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) –

• EngagementIdentifier (list) –

  An array of strings representing engagement identifiers to retrieve.

  • (string) –

• ExcludeCreatedBy (list) –

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

  • (string) –

• Sort (dict) –

  An object that specifies the sort order of the results.

  • SortBy (string) – [REQUIRED]

    The field by which to sort the results.

  • SortOrder (string) – [REQUIRED]

    The order in which to sort the results.

• 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',
            'CreatedAt': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'Id': 'string',
            'MemberCount': 123,
            'Title': 'string'
        },
    ],

}

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.

      • CreatedAt (datetime) –

        The date and time when the Engagement was created.

      • CreatedBy (string) –

        The AWS Account ID of the Engagement creator.

      • Id (string) –

        The unique identifier for the Engagement.

      • MemberCount (integer) –

        The number of members in the Engagement.

      • Title (string) –

        The title of the Engagement.