Describe Configuration Recorder Status

configservice_describe_configuration_recorder_status

R Documentation

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

Description

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.

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

Usage

configservice_describe_configuration_recorder_status(
  ConfigurationRecorderNames, ServicePrincipal, Arn)

Arguments

ConfigurationRecorderNames

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.

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

ServicePrincipal

For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder.

Arn

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

Value

A list with the following syntax:

list(
  ConfigurationRecordersStatus = list(
    list(
      arn = "string",
      name = "string",
      lastStartTime = as.POSIXct(
        "2015-01-01"
      ),
      lastStopTime = as.POSIXct(
        "2015-01-01"
      ),
      recording = TRUE|FALSE,
      lastStatus = "Pending"|"Success"|"Failure"|"NotApplicable",
      lastErrorCode = "string",
      lastErrorMessage = "string",
      lastStatusChangeTime = as.POSIXct(
        "2015-01-01"
      ),
      servicePrincipal = "string"
    )
  )
)

Request syntax

svc$describe_configuration_recorder_status(
  ConfigurationRecorderNames = list(
    "string"
  ),
  ServicePrincipal = "string",
  Arn = "string"
)