describe-configuration-recorder-status¶

Description¶

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.

Note

Currently, you can specify only one configuration recorder per region in your account.

Synopsis¶

  describe-configuration-recorder-status
[--configuration-recorder-names <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--configuration-recorder-names (list)

The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get status information for the configuration recorder

The following command returns the status of the default configuration recorder:

aws configservice describe-configuration-recorder-status

Output:

{
    "ConfigurationRecordersStatus": [
        {
            "name": "default",
            "lastStatus": "SUCCESS",
            "recording": true,
            "lastStatusChangeTime": 1452193834.344,
            "lastStartTime": 1441039997.819,
            "lastStopTime": 1441039992.835
        }
    ]
}

Output¶

ConfigurationRecordersStatus -> (list)

A list that contains status of the specified recorders.

(structure)

The current status of the configuration recorder.

name -> (string)

The name of the configuration recorder.

lastStartTime -> (timestamp)

The time the recorder was last started.

lastStopTime -> (timestamp)

The time the recorder was last stopped.

recording -> (boolean)

Specifies whether or not the recorder is currently recording.

lastStatus -> (string)

The last (previous) status of the recorder.

lastErrorCode -> (string)

The error code indicating that the recording failed.

lastErrorMessage -> (string)

The message indicating that the recording failed due to an error.

lastStatusChangeTime -> (timestamp)

The time when the status was last changed.

Table of Contents

Feedback

User Guide