PartnerCentralSellingAPI / Client / list_engagements

list_engagements#

PartnerCentralSellingAPI.Client.list_engagements(**kwargs)#

This action allows users to retrieve a list of engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.

See also: AWS API Documentation

Request Syntax

response = client.list_engagements(
    Catalog='string',
    CreatedBy=[
        'string',
    ],
    EngagementIdentifier=[
        'string',
    ],
    ExcludeCreatedBy=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    Sort={
        'SortBy': 'CreatedDate',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    }
)
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) –

  • MaxResults (integer) – The maximum number of results to return in a single call.

  • NextToken (string) – The token for the next set of results. This value is returned from a previous call.

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

Return type:

dict

Returns:

Response Syntax

{
    'EngagementSummaryList': [
        {
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'Id': 'string',
            'MemberCount': 123,
            'Title': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The token to retrieve the next set of results. This field will be null if there are no more results.

Exceptions