PartnerCentralSellingAPI / Paginator / ListEngagementResourceAssociations

ListEngagementResourceAssociations

class PartnerCentralSellingAPI.Paginator.ListEngagementResourceAssociations

paginator = client.get_paginator('list_engagement_resource_associations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    CreatedBy='string',
    EngagementIdentifier='string',
    ResourceIdentifier='string',
    ResourceType='Opportunity',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  Specifies the catalog in which to search for engagement-resource associations. Valid Values: “AWS” or “Sandbox”

  • AWS for production environments.

  • Sandbox for testing and development purposes.

• CreatedBy (string) – Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account.

• EngagementIdentifier (string) – Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.

• ResourceIdentifier (string) – Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.

• ResourceType (string) – Filters the results to include only associations with resources of the specified type.

• 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

{
    'EngagementResourceAssociationSummaries': [
        {
            'Catalog': 'string',
            'CreatedBy': 'string',
            'EngagementId': 'string',
            'ResourceId': 'string',
            'ResourceType': 'Opportunity'
        },
    ],

}

Response Structure

• (dict) –

  • EngagementResourceAssociationSummaries (list) –

    A list of engagement-resource association summaries.

    • (dict) –

      This provide a streamlined view of the relationships between engagements and resources. These summaries offer a crucial link between collaborative engagements and the specific resources involved, such as opportunities.These summaries are particularly valuable for partners navigating complex engagements with multiple resources. They enable quick insights into resource distribution across engagements, support efficient resource management, and help maintain a clear overview of collaborative activities.

      • Catalog (string) –

        Indicates the environment in which the resource and engagement exist.

      • CreatedBy (string) –

        The AWS account ID of the entity that owns the resource. Identifies the account responsible for or having primary control over the resource.

      • EngagementId (string) –

        A unique identifier for the engagement associated with the resource.

      • ResourceId (string) –

        A unique identifier for the specific resource. Varies depending on the resource type.

      • ResourceType (string) –

        Categorizes the type of resource associated with the engagement.