PartnerCentralSellingAPI / Client / list_engagement_resource_associations

list_engagement_resource_associations

PartnerCentralSellingAPI.Client.list_engagement_resource_associations(**kwargs)

Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.

See also: AWS API Documentation

Request Syntax

response = client.list_engagement_resource_associations(
    Catalog='string',
    MaxResults=123,
    NextToken='string',
    EngagementIdentifier='string',
    ResourceType='Opportunity',
    ResourceIdentifier='string',
    CreatedBy='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.

  • MaxResults (integer) – Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.

  • NextToken (string) – A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.

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

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

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

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

Return type:

dict

Returns:

Response Syntax

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

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.

        • EngagementId (string) –

          A unique identifier for the engagement associated with the resource.

        • ResourceType (string) –

          Categorizes the type of resource associated with the engagement.

        • ResourceId (string) –

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

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

    • NextToken (string) –

      A token to retrieve the next set of results. Use this token in a subsequent request to retrieve additional results if the response was truncated.

Exceptions