AWS Config
API Reference (API Version 2014-11-12)

BatchGetResourceConfig

Returns the current configuration 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, "configurationItemStatus": "string", "configurationStateId": "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 configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

HTTP Status Code: 400

ValidationException

The requested action is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: