describe_configuration_recorder_status

ConfigService.Client.describe_configuration_recorder_status(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration_recorder_status(
    ConfigurationRecorderNames=[
        'string',
    ]
)

Parameters

ConfigurationRecorderNames (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) --

Return type

dict

Returns

Response Syntax

{
    'ConfigurationRecordersStatus': [
        {
            'name': 'string',
            'lastStartTime': datetime(2015, 1, 1),
            'lastStopTime': datetime(2015, 1, 1),
            'recording': True|False,
            'lastStatus': 'Pending'|'Success'|'Failure',
            'lastErrorCode': 'string',
            'lastErrorMessage': 'string',
            'lastStatusChangeTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  The output for the DescribeConfigurationRecorderStatus action, in JSON format.

  • ConfigurationRecordersStatus (list) --

    A list that contains status of the specified recorders.

    • (dict) --

      The current status of the configuration recorder.

      • name (string) --

        The name of the configuration recorder.

      • lastStartTime (datetime) --

        The time the recorder was last started.

      • lastStopTime (datetime) --

        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 (datetime) --

        The time when the status was last changed.

Exceptions

• ConfigService.Client.exceptions.NoSuchConfigurationRecorderException