ConfigService / Client / describe_configuration_recorders

describe_configuration_recorders#

ConfigService.Client.describe_configuration_recorders(**kwargs)#

Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.

Note

Currently, you can specify only one configuration recorder per region in your account.

Request Syntax

response = client.describe_configuration_recorders(
    ConfigurationRecorderNames=[
        'string',
    ]
)

Parameters:

ConfigurationRecorderNames (list) –

A list of configuration recorder names.

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationRecorders': [
        {
            'name': 'string',
            'roleARN': 'string',
            'recordingGroup': {
                'allSupported': True|False,
                'includeGlobalResourceTypes': True|False,
                'resourceTypes': [
                    'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector'|'AWS::EMR::SecurityConfiguration'|'AWS::SageMaker::CodeRepository'|'AWS::Route53Resolver::ResolverEndpoint'|'AWS::Route53Resolver::ResolverRule'|'AWS::Route53Resolver::ResolverRuleAssociation'|'AWS::DMS::ReplicationSubnetGroup'|'AWS::DMS::EventSubscription'|'AWS::MSK::Cluster'|'AWS::StepFunctions::Activity'|'AWS::WorkSpaces::Workspace'|'AWS::WorkSpaces::ConnectionAlias'|'AWS::SageMaker::Model'|'AWS::ElasticLoadBalancingV2::Listener'|'AWS::StepFunctions::StateMachine'|'AWS::Batch::JobQueue'|'AWS::Batch::ComputeEnvironment'|'AWS::AccessAnalyzer::Analyzer'|'AWS::Athena::WorkGroup'|'AWS::Athena::DataCatalog'|'AWS::Detective::Graph'|'AWS::GlobalAccelerator::Accelerator'|'AWS::GlobalAccelerator::EndpointGroup'|'AWS::GlobalAccelerator::Listener'|'AWS::EC2::TransitGatewayAttachment'|'AWS::EC2::TransitGatewayRouteTable'|'AWS::DMS::Certificate'|'AWS::AppConfig::Application'|'AWS::AppSync::GraphQLApi'|'AWS::DataSync::LocationSMB'|'AWS::DataSync::LocationFSxLustre'|'AWS::DataSync::LocationS3'|'AWS::DataSync::LocationEFS'|'AWS::DataSync::Task'|'AWS::DataSync::LocationNFS'|'AWS::EC2::NetworkInsightsAccessScopeAnalysis'|'AWS::EKS::FargateProfile'|'AWS::Glue::Job'|'AWS::GuardDuty::ThreatIntelSet'|'AWS::GuardDuty::IPSet'|'AWS::SageMaker::Workteam'|'AWS::SageMaker::NotebookInstanceLifecycleConfig'|'AWS::ServiceDiscovery::Service'|'AWS::ServiceDiscovery::PublicDnsNamespace'|'AWS::SES::ContactList'|'AWS::SES::ConfigurationSet'|'AWS::Route53::HostedZone'|'AWS::IoTEvents::Input'|'AWS::IoTEvents::DetectorModel'|'AWS::IoTEvents::AlarmModel'|'AWS::ServiceDiscovery::HttpNamespace'|'AWS::Events::EventBus'|'AWS::ImageBuilder::ContainerRecipe'|'AWS::ImageBuilder::DistributionConfiguration'|'AWS::ImageBuilder::InfrastructureConfiguration'|'AWS::DataSync::LocationObjectStorage'|'AWS::DataSync::LocationHDFS'|'AWS::Glue::Classifier'|'AWS::Route53RecoveryReadiness::Cell'|'AWS::Route53RecoveryReadiness::ReadinessCheck'|'AWS::ECR::RegistryPolicy'|'AWS::Backup::ReportPlan'|'AWS::Lightsail::Certificate'|'AWS::RUM::AppMonitor'|'AWS::Events::Endpoint'|'AWS::SES::ReceiptRuleSet'|'AWS::Events::Archive'|'AWS::Events::ApiDestination'|'AWS::Lightsail::Disk'|'AWS::FIS::ExperimentTemplate'|'AWS::DataSync::LocationFSxWindows'|'AWS::SES::ReceiptFilter'|'AWS::GuardDuty::Filter'|'AWS::SES::Template'|'AWS::AmazonMQ::Broker'|'AWS::AppConfig::Environment'|'AWS::AppConfig::ConfigurationProfile'|'AWS::Cloud9::EnvironmentEC2'|'AWS::EventSchemas::Registry'|'AWS::EventSchemas::RegistryPolicy'|'AWS::EventSchemas::Discoverer'|'AWS::FraudDetector::Label'|'AWS::FraudDetector::EntityType'|'AWS::FraudDetector::Variable'|'AWS::FraudDetector::Outcome'|'AWS::IoT::Authorizer'|'AWS::IoT::SecurityProfile'|'AWS::IoT::RoleAlias'|'AWS::IoT::Dimension'|'AWS::IoTAnalytics::Datastore'|'AWS::Lightsail::Bucket'|'AWS::Lightsail::StaticIp'|'AWS::MediaPackage::PackagingGroup'|'AWS::Route53RecoveryReadiness::RecoveryGroup'|'AWS::ResilienceHub::ResiliencyPolicy'|'AWS::Transfer::Workflow'|'AWS::EKS::IdentityProviderConfig'|'AWS::EKS::Addon'|'AWS::Glue::MLTransform'|'AWS::IoT::Policy'|'AWS::IoT::MitigationAction'|'AWS::IoTTwinMaker::Workspace'|'AWS::IoTTwinMaker::Entity'|'AWS::IoTAnalytics::Dataset'|'AWS::IoTAnalytics::Pipeline'|'AWS::IoTAnalytics::Channel'|'AWS::IoTSiteWise::Dashboard'|'AWS::IoTSiteWise::Project'|'AWS::IoTSiteWise::Portal'|'AWS::IoTSiteWise::AssetModel'|'AWS::IVS::Channel'|'AWS::IVS::RecordingConfiguration'|'AWS::IVS::PlaybackKeyPair'|'AWS::KinesisAnalyticsV2::Application'|'AWS::RDS::GlobalCluster'|'AWS::S3::MultiRegionAccessPoint'|'AWS::DeviceFarm::TestGridProject'|'AWS::Budgets::BudgetsAction'|'AWS::Lex::Bot'|'AWS::CodeGuruReviewer::RepositoryAssociation'|'AWS::IoT::CustomMetric'|'AWS::Route53Resolver::FirewallDomainList'|'AWS::RoboMaker::RobotApplicationVersion'|'AWS::EC2::TrafficMirrorSession'|'AWS::IoTSiteWise::Gateway'|'AWS::Lex::BotAlias'|'AWS::LookoutMetrics::Alert'|'AWS::IoT::AccountAuditConfiguration'|'AWS::EC2::TrafficMirrorTarget'|'AWS::S3::StorageLens'|'AWS::IoT::ScheduledAudit'|'AWS::Events::Connection'|'AWS::EventSchemas::Schema'|'AWS::MediaPackage::PackagingConfiguration'|'AWS::KinesisVideo::SignalingChannel'|'AWS::AppStream::DirectoryConfig'|'AWS::LookoutVision::Project'|'AWS::Route53RecoveryControl::Cluster'|'AWS::Route53RecoveryControl::SafetyRule'|'AWS::Route53RecoveryControl::ControlPanel'|'AWS::Route53RecoveryControl::RoutingControl'|'AWS::Route53RecoveryReadiness::ResourceSet'|'AWS::RoboMaker::SimulationApplication'|'AWS::RoboMaker::RobotApplication'|'AWS::HealthLake::FHIRDatastore'|'AWS::Pinpoint::Segment'|'AWS::Pinpoint::ApplicationSettings'|'AWS::Events::Rule'|'AWS::EC2::DHCPOptions'|'AWS::EC2::NetworkInsightsPath'|'AWS::EC2::TrafficMirrorFilter'|'AWS::EC2::IPAM'|'AWS::IoTTwinMaker::Scene'|'AWS::NetworkManager::TransitGatewayRegistration'|'AWS::CustomerProfiles::Domain'|'AWS::AutoScaling::WarmPool'|'AWS::Connect::PhoneNumber'|'AWS::AppConfig::DeploymentStrategy'|'AWS::AppFlow::Flow'|'AWS::AuditManager::Assessment'|'AWS::CloudWatch::MetricStream'|'AWS::DeviceFarm::InstanceProfile'|'AWS::DeviceFarm::Project'|'AWS::EC2::EC2Fleet'|'AWS::EC2::SubnetRouteTableAssociation'|'AWS::ECR::PullThroughCacheRule'|'AWS::GroundStation::Config'|'AWS::ImageBuilder::ImagePipeline'|'AWS::IoT::FleetMetric'|'AWS::IoTWireless::ServiceProfile'|'AWS::NetworkManager::Device'|'AWS::NetworkManager::GlobalNetwork'|'AWS::NetworkManager::Link'|'AWS::NetworkManager::Site'|'AWS::Panorama::Package'|'AWS::Pinpoint::App'|'AWS::Redshift::ScheduledAction'|'AWS::Route53Resolver::FirewallRuleGroupAssociation'|'AWS::SageMaker::AppImageConfig'|'AWS::SageMaker::Image',
                ]
            }
        },
    ]
}

Response Structure

(dict) –

The output for the DescribeConfigurationRecorders action.
- ConfigurationRecorders (list) –
  
  A list that contains the descriptions of the specified configuration recorders.
  - (dict) –
    
    An object that represents the recording of configuration changes of an Amazon Web Services resource.
    - name (string) –
      
      The name of the recorder. By default, Config automatically assigns the name “default” when creating the configuration recorder. You cannot change the assigned name.
    - roleARN (string) –
      
      Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.
      
      Note
      While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.
    - recordingGroup (dict) –
      
      Specifies the types of Amazon Web Services resources for which Config records configuration changes.
      - allSupported (boolean) –
        
        Specifies whether Config records configuration changes for every supported type of regional resource.
        
        If you set this option to true, when Config adds support for a new type of regional resource, it starts recording resources of that type automatically.
        
        If you set this option to true, you cannot enumerate a list of resourceTypes.
      - includeGlobalResourceTypes (boolean) –
        
        Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
        
        Before you can set this option to true, you must set the allSupported option to true.
        
        If you set this option to true, when Config adds support for a new type of global resource, it starts recording resources of that type automatically.
        
        The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.
      - resourceTypes (list) –
        
        A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
        
        To record all configuration changes, you must set the allSupported option to true.
        
        If you set the AllSupported option to false and populate the ResourceTypes option with values, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.
        
        For a list of valid resourceTypes values, see the resourceType Value column in Supported Amazon Web Services resource Types.
        
        (string) –

Exceptions

ConfigService.Client.exceptions.NoSuchConfigurationRecorderException