GetResourcesV2
Returns a list of resources.
You can use the Scopes parameter to define the data boundary for the query. Currently, Scopes supports AwsOrganizations, which lets you retrieve resources from your entire organization or from specific organizational units. Only the delegated administrator account can use Scopes.
You can use the Filters parameter to refine results based on resource attributes. You can use Scopes and Filters independently or together. When both are provided, Scopes narrows the data set first, and then Filters refines results within that scoped data set.
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"
}
}
],
"NestedCompositeFilters": [
"ResourcesCompositeFilter"
],
"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",
"Scopes": {
"AwsOrganizations": [
{
"OrganizationalUnitId": "string",
"OrganizationId": "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
- Scopes
-
Limits the results to resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an
AccessDeniedException.This parameter is optional. If you omit it, the delegated administrator sees resources from all accounts across the entire organization. Other accounts see only their own resources.
You can specify up to 10 entries in
Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.Type: ResourceScopes object
Required: No
- SortCriteria
-
The resource attributes used to sort the list of returned resources.
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",
"ResourceCategory": "string",
"ResourceConfig": JSON value,
"ResourceCreationTimeDt": "string",
"ResourceDetailCaptureTimeDt": "string",
"ResourceGuid": "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
-
An array of resources returned by the operation.
Type: Array of ResourceResult objects
Errors
For information about the errors that are common to all actions, see Common Error Types.
- 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
- OrganizationalUnitNotFoundException
-
The request failed because one or more organizational units specified in the request don't exist within the caller's organization.
HTTP Status Code: 400
- OrganizationNotFoundException
-
The request failed because one or more organizations specified in the request don't exist or don't belong to the caller's organization.
HTTP Status Code: 400
- 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 AWS SDKs, see the following:
