Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListEngagementResourceAssociations

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

Request Syntax


{
   "Catalog": "string",
   "CreatedBy": "string",
   "EngagementIdentifier": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceIdentifier": "string",
   "ResourceType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Catalog

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.

Type: String

Pattern: ^[a-zA-Z]+$

Required: Yes

CreatedBy

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.

Type: String

Pattern: ^([0-9]{12}|\w{1,12})$

Required: No

EngagementIdentifier

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.

Type: String

Pattern: ^eng-[0-9a-z]{14}$

Required: No

MaxResults

Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.

Type: String

Required: No

ResourceIdentifier

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.

Type: String

Pattern: ^O[0-9]{1,19}$

Required: No

ResourceType

Filters the results to include only associations with resources of the specified type.

Type: String

Valid Values: Opportunity

Required: No

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EngagementResourceAssociationSummaries

A list of engagement-resource association summaries.

Type: Array of EngagementResourceAssociationSummary objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

HTTP Status Code: 400

ResourceNotFoundException

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

HTTP Status Code: 400

ThrottlingException

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

HTTP Status Code: 400