Use `DescribeConfigurationRecorders` with a CLI

PDF

RSS

Focus mode

Use DescribeConfigurationRecorders with a CLI - AWS Config

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.

anchor anchor

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.

For a complete list of AWS SDK developer guides and code examples, see Using AWS Config with an AWS SDK. This topic also includes information about getting started and details about previous SDK versions.