Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetAggregateResourceConfig

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

Note

The API does not return results for deleted resources.

Request Syntax


{
   "ConfigurationAggregatorName": "string",
   "ResourceIdentifier": { 
      "ResourceId": "string",
      "ResourceName": "string",
      "ResourceType": "string",
      "SourceAccountId": "string",
      "SourceRegion": "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.

ConfigurationAggregatorName

The name of the configuration aggregator.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\w\-]+

Required: Yes

ResourceIdentifier

An object that identifies aggregate resource.

Type: AggregateResourceIdentifier object

Required: Yes

Response Syntax


{
   "ConfigurationItem": { 
      "accountId": "string",
      "arn": "string",
      "availabilityZone": "string",
      "awsRegion": "string",
      "configuration": "string",
      "configurationItemCaptureTime": number,
      "configurationItemDeliveryTime": number,
      "configurationItemMD5Hash": "string",
      "configurationItemStatus": "string",
      "configurationStateId": "string",
      "recordingFrequency": "string",
      "relatedEvents": [ "string" ],
      "relationships": [ 
         { 
            "relationshipName": "string",
            "resourceId": "string",
            "resourceName": "string",
            "resourceType": "string"
         }
      ],
      "resourceCreationTime": number,
      "resourceId": "string",
      "resourceName": "string",
      "resourceType": "string",
      "supplementaryConfiguration": { 
         "string" : "string" 
      },
      "tags": { 
         "string" : "string" 
      },
      "version": "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.

ConfigurationItem

Returns a ConfigurationItem object.

Type: ConfigurationItem object

Errors

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

NoSuchConfigurationAggregatorException

You have specified a configuration aggregator that does not exist.

HTTP Status Code: 400

OversizedConfigurationItemException

The configuration item size is outside the allowable range.

HTTP Status Code: 400

ResourceNotDiscoveredException

You have specified a resource that is either unknown or has not been discovered.

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