GetResourcesV2
Returns a list of resources. This API is in private preview and subject to change.
Request Syntax
POST /resourcesv2 HTTP/1.1
Content-type: application/json
{
"Filters": {
"CompositeFilters": [
{
"DateFilters": [
{
"FieldName": "string",
"Filter": {
"DateRange": {
"Unit": "string",
"Value": number
},
"End": "string",
"Start": "string"
}
}
],
"MapFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Key": "string",
"Value": "string"
}
}
],
"NumberFilters": [
{
"FieldName": "string",
"Filter": {
"Eq": number,
"Gt": number,
"Gte": number,
"Lt": number,
"Lte": number
}
}
],
"Operator": "string",
"StringFilters": [
{
"FieldName": "string",
"Filter": {
"Comparison": "string",
"Value": "string"
}
}
]
}
],
"CompositeOperator": "string"
},
"MaxResults": number,
"NextToken": "string",
"SortCriteria": [
{
"Field": "string",
"SortOrder": "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 resources based on a set of criteria.
Type: ResourcesFilters object
Required: No
- MaxResults
-
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token required for pagination. On your first call, set the value of this parameter to
NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.Type: String
Required: No
- SortCriteria
-
The finding attributes used to sort the list of returned findings.
Type: Array of SortCriterion objects
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Resources": [
{
"AccountId": "string",
"FindingsSummary": [
{
"FindingType": "string",
"ProductName": "string",
"Severities": {
"Critical": number,
"Fatal": number,
"High": number,
"Informational": number,
"Low": number,
"Medium": number,
"Other": number,
"Unknown": number
},
"TotalFindings": number
}
],
"Region": "string",
"ResourceArn": "string",
"ResourceCategory": "string",
"ResourceConfig": JSON value,
"ResourceCreationTimeDt": "string",
"ResourceDetailCaptureTimeDt": "string",
"ResourceId": "string",
"ResourceName": "string",
"ResourceTags": [
{
"Key": "string",
"Value": "string"
}
],
"ResourceType": "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 request the next page of results. Otherwise, this parameter is null.
Type: String
- Resources
-
Filters resources based on a set of criteria.
Type: Array of ResourceResult objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
- ConflictException
-
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
- InternalServerException
-
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
- ThrottlingException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
- ValidationException
-
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: