BatchGetResourceConfig
Returns the BaseConfigurationItem for one or more requested resources.
The operation also returns a list of resources that are
not processed in the current request. If there are no unprocessed
resources, the operation returns an empty unprocessedResourceKeys
list.
Note
-
The API does not return results for deleted resources.
-
The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
Request Syntax
{
"resourceKeys": [
{
"resourceId": "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.
- resourceKeys
-
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
Type: Array of ResourceKey objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
Response Syntax
{
"baseConfigurationItems": [
{
"accountId": "string",
"arn": "string",
"availabilityZone": "string",
"awsRegion": "string",
"configuration": "string",
"configurationItemCaptureTime": number,
"configurationItemDeliveryTime": number,
"configurationItemStatus": "string",
"configurationStateId": "string",
"recordingFrequency": "string",
"resourceCreationTime": number,
"resourceId": "string",
"resourceName": "string",
"resourceType": "string",
"supplementaryConfiguration": {
"string" : "string"
},
"version": "string"
}
],
"unprocessedResourceKeys": [
{
"resourceId": "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.
- baseConfigurationItems
-
A list that contains the current configuration of one or more resources.
Type: Array of BaseConfigurationItem objects
- unprocessedResourceKeys
-
A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.
Type: Array of ResourceKey objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoAvailableConfigurationRecorderException
-
There are no customer managed configuration recorders available to record your resources. Use the PutConfigurationRecorder operation to create the customer managed configuration recorder.
HTTP Status Code: 400
- ValidationException
-
The requested operation is not valid. You will see this exception if there are missing required fields or if the input value fails the validation.
For PutStoredQuery, one of the following errors:
-
There are missing required fields.
-
The input value fails the validation.
-
You are trying to create more than 300 queries.
For DescribeConfigurationRecorders and DescribeConfigurationRecorderStatus, one of the following errors:
-
You have specified more than one configuration recorder.
-
You have provided a service principal for service-linked configuration recorder that is not valid.
For AssociateResourceTypes and DisassociateResourceTypes, one of the following errors:
-
Your configuraiton recorder has a recording strategy that does not allow the association or disassociation of resource types.
-
One or more of the specified resource types are already associated or disassociated with the configuration recorder.
-
For service-linked configuration recorders, the configuration recorder does not record one or more of the specified resource types.
HTTP Status Code: 400
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
