Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetResourceCollection

Returns lists of AWS resources that are of the specified resource collection type. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag. DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 1000 AWS CloudFormation stacks.

Request Syntax


GET /resource-collections/ResourceCollectionType?NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

NextToken

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

ResourceCollectionType

The type of AWS resource collection to return. You can use AWS CloudFormation stacks or AWS tags as a resource collection. You can use your resource collection to specify the resources you want DevOps Guru to analyze.

Valid Values: AWS_CLOUD_FORMATION | AWS_SERVICE | AWS_TAGS

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ResourceCollection": { 
      "CloudFormation": { 
         "StackNames": [ "string" ]
      },
      "Tags": [ 
         { 
            "AppBoundaryKey": "string",
            "TagValues": [ "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.

NextToken

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

ResourceCollection

The requested list of AWS resource collections. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag. DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 1000 AWS CloudFormation stacks.

Type: ResourceCollectionFilter object

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

InternalServerException

An internal failure in an Amazon service occurred.

RetryAfterSeconds: The number of seconds after which the action that caused the internal server exception can be retried.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource could not be found

ResourceId: The ID of the AWS resource that could not be found.
ResourceType: The type of the AWS resource that could not be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to a request throttling.

QuotaCode: The code of the quota that was exceeded, causing the throttling exception.
RetryAfterSeconds: The number of seconds after which the action that caused the throttling exception can be retried.
ServiceCode: The code of the service that caused the throttling exception.

HTTP Status Code: 429

ValidationException

Contains information about data passed in to a field during a request that is not valid.

Fields: An array of fields that are associated with the validation exception.
Message: A message that describes the validation exception.
Reason: The reason the validation exception was thrown.

HTTP Status Code: 400