ConfigService / Client / describe_configuration_recorder_status

describe_configuration_recorder_status#

ConfigService.Client.describe_configuration_recorder_status(**kwargs)#

Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.

Note

>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.

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.

        Note

        For a detailed status of recording events over time, add your Config events to CloudWatch metrics and use CloudWatch metrics.

        • 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 status of the latest recording event processed by the recorder.

        • lastErrorCode (string) –

          The latest error code from when the recorder last failed.

        • lastErrorMessage (string) –

          The latest error message from when the recorder last failed.

        • lastStatusChangeTime (datetime) –

          The time of the latest change in status of an recording event processed by the recorder.

Exceptions