Viewing the Configuration Recorder
You must use the AWS CLI to view details about the configuration recorder.
The following code examples show how to use DescribeConfigurationRecorders
.
- CLI
-
- AWS CLI
-
To get details about the configuration recorder
The following command returns details about the default configuration recorder:
aws configservice describe-configuration-recorders
Output:
{ "ConfigurationRecorders": [ { "recordingGroup": { "allSupported": true, "resourceTypes": [], "includeGlobalResourceTypes": true }, "roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6", "name": "default" } ] }
-
For API details, see DescribeConfigurationRecorders
in AWS CLI Command Reference.
-
- PowerShell
-
- Tools for PowerShell
-
Example 1: This example returns the details of configuration recorders.
Get-CFGConfigurationRecorder | Format-List
Output:
Name : default RecordingGroup : Amazon.ConfigService.Model.RecordingGroup RoleARN : arn:aws:iam::123456789012:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig
-
For API details, see DescribeConfigurationRecorders in AWS Tools for PowerShell Cmdlet Reference.
-
The following code examples show how to use DescribeConfigurationRecorderStatus
.
- CLI
-
- AWS CLI
-
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 } ] }
-
For API details, see DescribeConfigurationRecorderStatus
in AWS CLI Command Reference.
-
- PowerShell
-
- Tools for PowerShell
-
Example 1: This sample returns status of the configuration recorders.
Get-CFGConfigurationRecorderStatus
Output:
LastErrorCode : LastErrorMessage : LastStartTime : 10/11/2019 10:13:51 AM LastStatus : Success LastStatusChangeTime : 12/31/2019 6:14:12 AM LastStopTime : 10/11/2019 10:13:46 AM Name : default Recording : True
-
For API details, see DescribeConfigurationRecorderStatus in AWS Tools for PowerShell Cmdlet Reference.
-