ConfigService / Client / describe_configuration_recorder_status

describe_configuration_recorder_status#

ConfigService.Client.describe_configuration_recorder_status(**kwargs)#

Returns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders.

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

If a configuration recorder is not specified, this operation returns the status for the customer managed configuration recorder configured for the account, if applicable.

Note

When making a request to this operation, you can only specify one configuration recorder.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration_recorder_status(
    ConfigurationRecorderNames=[
        'string',
    ],
    ServicePrincipal='string',
    Arn='string'
)
Parameters:

  • ConfigurationRecorderNames (list) –

    The name of the configuration recorder. If the name is not specified, the opertation returns the status for the customer managed configuration recorder configured for the account, if applicable.

    Note

    When making a request to this operation, you can only specify one configuration recorder.

    • (string) –

  • ServicePrincipal (string) – For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder.

  • Arn (string) – The Amazon Resource Name (ARN) of the configuration recorder that you want to specify.

Return type:

dict

Returns:

Response Syntax

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

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.

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

        • arn (string) –

          The Amazon Resource Name (ARN) 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 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.

        • servicePrincipal (string) –

          For service-linked configuration recorders, the service principal of the linked Amazon Web Services service.

Exceptions

  • ConfigService.Client.exceptions.NoSuchConfigurationRecorderException

  • ConfigService.Client.exceptions.ValidationException