View a markdown version of this page

Use DescribeConfigurationRecorders with a CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use DescribeConfigurationRecorders with a CLI

The following code examples show how to use DescribeConfigurationRecorders.

Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:

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"
        }
    ]
}
PowerShell
Tools for PowerShell V4

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
Tools for PowerShell V5

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