Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . configservice ]



Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.


The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.

When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.

Write-only schema properites are not recorded as part of the published configuration item.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--resource-type <value>
--schema-version-id <value>
--resource-id <value>
[--resource-name <value>]
--configuration <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--resource-type (string)

The type of the resource. The custom resource type must be registered with CloudFormation.


You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.

--schema-version-id (string)

Version of the schema registered for the ResourceType in CloudFormation.

--resource-id (string)

Unique identifier of the resource.

--resource-name (string)

Name of the resource.

--configuration (string)

The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.


The configuration JSON must not exceed 64 KB.

--tags (map)

Tags associated with the resource.

key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.