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

ListMonitoredResources

Returns the list of resources that are being monitored by DevOps Guru.

Request Syntax


POST /monitoredResources HTTP/1.1
Content-type: application/json

{
   "Filters": { 
      "ResourcePermission": "string",
      "ResourceTypeFilters": [ "string" ]
   },
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filters

Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status.

Type: ListMonitoredResourcesFilters object

Required: No

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Type: Integer

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

Required: No

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.

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}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "MonitoredResourceIdentifiers": [ 
      { 
         "LastUpdated": number,
         "MonitoredResourceName": "string",
         "ResourceCollection": { 
            "CloudFormation": { 
               "StackNames": [ "string" ]
            },
            "Tags": [ 
               { 
                  "AppBoundaryKey": "string",
                  "TagValues": [ "string" ]
               }
            ]
         },
         "ResourcePermission": "string",
         "Type": "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.

MonitoredResourceIdentifiers

Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource.

Type: Array of MonitoredResourceIdentifier objects

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}$

Errors

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

InternalServerException

An internal failure in an Amazon service occurred.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource could not be found

HTTP Status Code: 404

ThrottlingException

The request was denied due to a request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400