AWS Config 2014-11-12
- Client: Aws\ConfigService\ConfigServiceClient
- Service ID: config
- Version: 2014-11-12
This page describes the parameters and results for the operations of the AWS Config (2014-11-12), and shows how to use the Aws\ConfigService\ConfigServiceClient object to call the described operations. This documentation is specific to the 2014-11-12 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- BatchGetAggregateResourceConfig ( array $params = [] )
- Returns the current configuration items for resources that are present in your Config aggregator.
- BatchGetResourceConfig ( array $params = [] )
- Returns the BaseConfigurationItem for one or more requested resources.
- DeleteAggregationAuthorization ( array $params = [] )
- Deletes the authorization granted to the specified configuration aggregator account in a specified region.
- DeleteConfigRule ( array $params = [] )
- Deletes the specified Config rule and all of its evaluation results.
- DeleteConfigurationAggregator ( array $params = [] )
- Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
- DeleteConfigurationRecorder ( array $params = [] )
- Deletes the configuration recorder.
- DeleteConformancePack ( array $params = [] )
- Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
- DeleteDeliveryChannel ( array $params = [] )
- Deletes the delivery channel.
- DeleteEvaluationResults ( array $params = [] )
- Deletes the evaluation results for the specified Config rule.
- DeleteOrganizationConfigRule ( array $params = [] )
- Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
- DeleteOrganizationConformancePack ( array $params = [] )
- Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
- DeletePendingAggregationRequest ( array $params = [] )
- Deletes pending authorization requests for a specified aggregator account in a specified region.
- DeleteRemediationConfiguration ( array $params = [] )
- Deletes the remediation configuration.
- DeleteRemediationExceptions ( array $params = [] )
- Deletes one or more remediation exceptions mentioned in the resource keys.
- DeleteResourceConfig ( array $params = [] )
- Records the configuration state for a custom resource that has been deleted.
- DeleteRetentionConfiguration ( array $params = [] )
- Deletes the retention configuration.
- DeleteStoredQuery ( array $params = [] )
- Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
- DeliverConfigSnapshot ( array $params = [] )
- Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
- DescribeAggregateComplianceByConfigRules ( array $params = [] )
- Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.
- DescribeAggregateComplianceByConformancePacks ( array $params = [] )
- Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.
- DescribeAggregationAuthorizations ( array $params = [] )
- Returns a list of authorizations granted to various aggregator accounts and regions.
- DescribeComplianceByConfigRule ( array $params = [] )
- Indicates whether the specified Config rules are compliant.
- DescribeComplianceByResource ( array $params = [] )
- Indicates whether the specified Amazon Web Services resources are compliant.
- DescribeConfigRuleEvaluationStatus ( array $params = [] )
- Returns status information for each of your Config managed rules.
- DescribeConfigRules ( array $params = [] )
- Returns details about your Config rules.
- DescribeConfigurationAggregatorSourcesStatus ( array $params = [] )
- Returns status information for sources within an aggregator.
- DescribeConfigurationAggregators ( array $params = [] )
- Returns the details of one or more configuration aggregators.
- DescribeConfigurationRecorderStatus ( array $params = [] )
- Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder.
- DescribeConfigurationRecorders ( array $params = [] )
- Returns the details for the specified configuration recorders.
- DescribeConformancePackCompliance ( array $params = [] )
- Returns compliance details for each rule in that conformance pack.
- DescribeConformancePackStatus ( array $params = [] )
- Provides one or more conformance packs deployment status.
- DescribeConformancePacks ( array $params = [] )
- Returns a list of one or more conformance packs.
- DescribeDeliveryChannelStatus ( array $params = [] )
- Returns the current status of the specified delivery channel.
- DescribeDeliveryChannels ( array $params = [] )
- Returns details about the specified delivery channel.
- DescribeOrganizationConfigRuleStatuses ( array $params = [] )
- Provides organization Config rule deployment status for an organization.
- DescribeOrganizationConfigRules ( array $params = [] )
- Returns a list of organization Config rules.
- DescribeOrganizationConformancePackStatuses ( array $params = [] )
- Provides organization conformance pack deployment status for an organization.
- DescribeOrganizationConformancePacks ( array $params = [] )
- Returns a list of organization conformance packs.
- DescribePendingAggregationRequests ( array $params = [] )
- Returns a list of all pending aggregation requests.
- DescribeRemediationConfigurations ( array $params = [] )
- Returns the details of one or more remediation configurations.
- DescribeRemediationExceptions ( array $params = [] )
- Returns the details of one or more remediation exceptions.
- DescribeRemediationExecutionStatus ( array $params = [] )
- Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed.
- DescribeRetentionConfigurations ( array $params = [] )
- Returns the details of one or more retention configurations.
- GetAggregateComplianceDetailsByConfigRule ( array $params = [] )
- Returns the evaluation results for the specified Config rule for a specific resource in a rule.
- GetAggregateConfigRuleComplianceSummary ( array $params = [] )
- Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
- GetAggregateConformancePackComplianceSummary ( array $params = [] )
- Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.
- GetAggregateDiscoveredResourceCounts ( array $params = [] )
- Returns the resource counts across accounts and regions that are present in your Config aggregator.
- GetAggregateResourceConfig ( array $params = [] )
- Returns configuration item that is aggregated for your specific resource in a specific source account and region.
- GetComplianceDetailsByConfigRule ( array $params = [] )
- Returns the evaluation results for the specified Config rule.
- GetComplianceDetailsByResource ( array $params = [] )
- Returns the evaluation results for the specified Amazon Web Services resource.
- GetComplianceSummaryByConfigRule ( array $params = [] )
- Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
- GetComplianceSummaryByResourceType ( array $params = [] )
- Returns the number of resources that are compliant and the number that are noncompliant.
- GetConformancePackComplianceDetails ( array $params = [] )
- Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
- GetConformancePackComplianceSummary ( array $params = [] )
- Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
- GetCustomRulePolicy ( array $params = [] )
- Returns the policy definition containing the logic for your Config Custom Policy rule.
- GetDiscoveredResourceCounts ( array $params = [] )
- Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
- GetOrganizationConfigRuleDetailedStatus ( array $params = [] )
- Returns detailed status for each member account within an organization for a given organization Config rule.
- GetOrganizationConformancePackDetailedStatus ( array $params = [] )
- Returns detailed status for each member account within an organization for a given organization conformance pack.
- GetOrganizationCustomRulePolicy ( array $params = [] )
- Returns the policy definition containing the logic for your organization Config Custom Policy rule.
- GetResourceConfigHistory ( array $params = [] )
- For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type.
- GetResourceEvaluationSummary ( array $params = [] )
- Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.
- GetStoredQuery ( array $params = [] )
- Returns the details of a specific stored query.
- ListAggregateDiscoveredResources ( array $params = [] )
- Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.
- ListConformancePackComplianceScores ( array $params = [] )
- Returns a list of conformance pack compliance scores.
- ListDiscoveredResources ( array $params = [] )
- Accepts a resource type and returns a list of resource identifiers for the resources of that type.
- ListResourceEvaluations ( array $params = [] )
- Returns a list of proactive resource evaluations.
- ListStoredQueries ( array $params = [] )
- Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.
- ListTagsForResource ( array $params = [] )
- List the tags for Config resource.
- PutAggregationAuthorization ( array $params = [] )
- Authorizes the aggregator account and region to collect data from the source account and region.
- PutConfigRule ( array $params = [] )
- Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations.
- PutConfigurationAggregator ( array $params = [] )
- Creates and updates the configuration aggregator with the selected source accounts and regions.
- PutConfigurationRecorder ( array $params = [] )
- Creates a new configuration recorder to record configuration changes for specified resource types.
- PutConformancePack ( array $params = [] )
- Creates or updates a conformance pack.
- PutDeliveryChannel ( array $params = [] )
- Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic.
- PutEvaluations ( array $params = [] )
- Used by an Lambda function to deliver evaluation results to Config.
- PutExternalEvaluation ( array $params = [] )
- Add or updates the evaluations for process checks.
- PutOrganizationConfigRule ( array $params = [] )
- Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations.
- PutOrganizationConformancePack ( array $params = [] )
- Deploys conformance packs across member accounts in an Amazon Web Services Organization.
- PutRemediationConfigurations ( array $params = [] )
- Adds or updates the remediation configuration with a specific Config rule with the selected target or action.
- PutRemediationExceptions ( array $params = [] )
- A remediation exception is when a specified resource is no longer considered for auto-remediation.
- PutResourceConfig ( array $params = [] )
- Records the configuration state for the resource provided in the request.
- PutRetentionConfiguration ( array $params = [] )
- Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information.
- PutStoredQuery ( array $params = [] )
- Saves a new query or updates an existing saved query.
- SelectAggregateResourceConfig ( array $params = [] )
- Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
- SelectResourceConfig ( array $params = [] )
- Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.
- StartConfigRulesEvaluation ( array $params = [] )
- Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.
- StartConfigurationRecorder ( array $params = [] )
- Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
- StartRemediationExecution ( array $params = [] )
- Runs an on-demand remediation for the specified Config rules against the last known remediation configuration.
- StartResourceEvaluation ( array $params = [] )
- Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.
- StopConfigurationRecorder ( array $params = [] )
- Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
- TagResource ( array $params = [] )
- Associates the specified tags to a resource with the specified resourceArn.
- UntagResource ( array $params = [] )
- Deletes specified tags from a resource.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeAggregateComplianceByConfigRules
- DescribeAggregateComplianceByConformancePacks
- DescribeAggregationAuthorizations
- DescribeComplianceByConfigRule
- DescribeComplianceByResource
- DescribeConfigRuleEvaluationStatus
- DescribeConfigRules
- DescribeConfigurationAggregatorSourcesStatus
- DescribeConfigurationAggregators
- DescribeConformancePackCompliance
- DescribeConformancePackStatus
- DescribeConformancePacks
- DescribeOrganizationConfigRuleStatuses
- DescribeOrganizationConfigRules
- DescribeOrganizationConformancePackStatuses
- DescribeOrganizationConformancePacks
- DescribePendingAggregationRequests
- DescribeRemediationExceptions
- DescribeRemediationExecutionStatus
- DescribeRetentionConfigurations
- GetAggregateComplianceDetailsByConfigRule
- GetAggregateConfigRuleComplianceSummary
- GetAggregateConformancePackComplianceSummary
- GetAggregateDiscoveredResourceCounts
- GetComplianceDetailsByConfigRule
- GetComplianceDetailsByResource
- GetConformancePackComplianceDetails
- GetConformancePackComplianceSummary
- GetDiscoveredResourceCounts
- GetOrganizationConfigRuleDetailedStatus
- GetOrganizationConformancePackDetailedStatus
- GetResourceConfigHistory
- ListAggregateDiscoveredResources
- ListConformancePackComplianceScores
- ListDiscoveredResources
- ListResourceEvaluations
- ListStoredQueries
- ListTagsForResource
- SelectAggregateResourceConfig
- SelectResourceConfig
Operations
BatchGetAggregateResourceConfig
$result = $client->batchGetAggregateResourceConfig
([/* ... */]); $promise = $client->batchGetAggregateResourceConfigAsync
([/* ... */]);
Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers
list.
-
The API does not return results for deleted resources.
-
The API does not return tags and relationships.
Parameter Syntax
$result = $client->batchGetAggregateResourceConfig([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'ResourceIdentifiers' => [ // REQUIRED [ 'ResourceId' => '<string>', // REQUIRED 'ResourceName' => '<string>', 'ResourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', // REQUIRED 'SourceAccountId' => '<string>', // REQUIRED 'SourceRegion' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- ResourceIdentifiers
-
- Required: Yes
- Type: Array of AggregateResourceIdentifier structures
A list of aggregate ResourceIdentifiers objects.
Result Syntax
[ 'BaseConfigurationItems' => [ [ 'accountId' => '<string>', 'arn' => '<string>', 'availabilityZone' => '<string>', 'awsRegion' => '<string>', 'configuration' => '<string>', 'configurationItemCaptureTime' => <DateTime>, 'configurationItemDeliveryTime' => <DateTime>, 'configurationItemStatus' => 'OK|ResourceDiscovered|ResourceNotRecorded|ResourceDeleted|ResourceDeletedNotRecorded', 'configurationStateId' => '<string>', 'recordingFrequency' => 'CONTINUOUS|DAILY', 'resourceCreationTime' => <DateTime>, 'resourceId' => '<string>', 'resourceName' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', 'supplementaryConfiguration' => ['<string>', ...], 'version' => '<string>', ], // ... ], 'UnprocessedResourceIdentifiers' => [ [ 'ResourceId' => '<string>', 'ResourceName' => '<string>', 'ResourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', 'SourceAccountId' => '<string>', 'SourceRegion' => '<string>', ], // ... ], ]
Result Details
Members
- BaseConfigurationItems
-
- Type: Array of BaseConfigurationItem structures
A list that contains the current configuration of one or more resources.
- UnprocessedResourceIdentifiers
-
- Type: Array of AggregateResourceIdentifier structures
A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
BatchGetResourceConfig
$result = $client->batchGetResourceConfig
([/* ... */]); $promise = $client->batchGetResourceConfigAsync
([/* ... */]);
Returns the BaseConfigurationItem
for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.
-
The API does not return results for deleted resources.
-
The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
Parameter Syntax
$result = $client->batchGetResourceConfig([ 'resourceKeys' => [ // REQUIRED [ 'resourceId' => '<string>', // REQUIRED 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- resourceKeys
-
- Required: Yes
- Type: Array of ResourceKey structures
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
Result Syntax
[ 'baseConfigurationItems' => [ [ 'accountId' => '<string>', 'arn' => '<string>', 'availabilityZone' => '<string>', 'awsRegion' => '<string>', 'configuration' => '<string>', 'configurationItemCaptureTime' => <DateTime>, 'configurationItemDeliveryTime' => <DateTime>, 'configurationItemStatus' => 'OK|ResourceDiscovered|ResourceNotRecorded|ResourceDeleted|ResourceDeletedNotRecorded', 'configurationStateId' => '<string>', 'recordingFrequency' => 'CONTINUOUS|DAILY', 'resourceCreationTime' => <DateTime>, 'resourceId' => '<string>', 'resourceName' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', 'supplementaryConfiguration' => ['<string>', ...], 'version' => '<string>', ], // ... ], 'unprocessedResourceKeys' => [ [ 'resourceId' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', ], // ... ], ]
Result Details
Members
- baseConfigurationItems
-
- Type: Array of BaseConfigurationItem structures
A list that contains the current configuration of one or more resources.
- unprocessedResourceKeys
-
- Type: Array of ResourceKey structures
A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoAvailableConfigurationRecorderException:
There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
DeleteAggregationAuthorization
$result = $client->deleteAggregationAuthorization
([/* ... */]); $promise = $client->deleteAggregationAuthorizationAsync
([/* ... */]);
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
Parameter Syntax
$result = $client->deleteAggregationAuthorization([ 'AuthorizedAccountId' => '<string>', // REQUIRED 'AuthorizedAwsRegion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AuthorizedAccountId
-
- Required: Yes
- Type: string
The 12-digit account ID of the account authorized to aggregate data.
- AuthorizedAwsRegion
-
- Required: Yes
- Type: string
The region authorized to collect aggregated data.
Result Syntax
[]
Result Details
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
DeleteConfigRule
$result = $client->deleteConfigRule
([/* ... */]); $promise = $client->deleteConfigRuleAsync
([/* ... */]);
Deletes the specified Config rule and all of its evaluation results.
Config sets the state of a rule to DELETING
until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule
or DeleteConfigRule
request for the rule, you will receive a ResourceInUseException
.
You can check the state of a rule by using the DescribeConfigRules
request.
Parameter Syntax
$result = $client->deleteConfigRule([ 'ConfigRuleName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule that you want to delete.
Result Syntax
[]
Result Details
Errors
- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
DeleteConfigurationAggregator
$result = $client->deleteConfigurationAggregator
([/* ... */]); $promise = $client->deleteConfigurationAggregatorAsync
([/* ... */]);
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
Parameter Syntax
$result = $client->deleteConfigurationAggregator([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
Result Syntax
[]
Result Details
Errors
- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
DeleteConfigurationRecorder
$result = $client->deleteConfigurationRecorder
([/* ... */]); $promise = $client->deleteConfigurationRecorderAsync
([/* ... */]);
Deletes the configuration recorder.
After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.
This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory
action, but you will not be able to access this information in the Config console until you create a new configuration recorder.
Parameter Syntax
$result = $client->deleteConfigurationRecorder([ 'ConfigurationRecorderName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConfigurationRecorderName
-
- Required: Yes
- Type: string
The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the
DescribeConfigurationRecorders
action.
Result Syntax
[]
Result Details
Errors
- NoSuchConfigurationRecorderException:
You have specified a configuration recorder that does not exist.
DeleteConformancePack
$result = $client->deleteConformancePack
([/* ... */]); $promise = $client->deleteConformancePackAsync
([/* ... */]);
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Config sets the conformance pack to DELETE_IN_PROGRESS
until the deletion is complete. You cannot update a conformance pack while it is in this state.
Parameter Syntax
$result = $client->deleteConformancePack([ 'ConformancePackName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConformancePackName
-
- Required: Yes
- Type: string
Name of the conformance pack you want to delete.
Result Syntax
[]
Result Details
Errors
- NoSuchConformancePackException:
You specified one or more conformance packs that do not exist.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
DeleteDeliveryChannel
$result = $client->deleteDeliveryChannel
([/* ... */]); $promise = $client->deleteDeliveryChannelAsync
([/* ... */]);
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
Parameter Syntax
$result = $client->deleteDeliveryChannel([ 'DeliveryChannelName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DeliveryChannelName
-
- Required: Yes
- Type: string
The name of the delivery channel to delete.
Result Syntax
[]
Result Details
Errors
- NoSuchDeliveryChannelException:
You have specified a delivery channel that does not exist.
- LastDeliveryChannelDeleteFailedException:
You cannot delete the delivery channel you specified because the configuration recorder is running.
DeleteEvaluationResults
$result = $client->deleteEvaluationResults
([/* ... */]); $promise = $client->deleteEvaluationResultsAsync
([/* ... */]);
Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.
Parameter Syntax
$result = $client->deleteEvaluationResults([ 'ConfigRuleName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule for which you want to delete the evaluation results.
Result Syntax
[]
Result Details
Errors
- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
DeleteOrganizationConfigRule
$result = $client->deleteOrganizationConfigRule
([/* ... */]); $promise = $client->deleteOrganizationConfigRuleAsync
([/* ... */]);
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Only a management account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added.
Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
Parameter Syntax
$result = $client->deleteOrganizationConfigRule([ 'OrganizationConfigRuleName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- OrganizationConfigRuleName
-
- Required: Yes
- Type: string
The name of organization Config rule that you want to delete.
Result Syntax
[]
Result Details
Errors
- NoSuchOrganizationConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
DeleteOrganizationConformancePack
$result = $client->deleteOrganizationConformancePack
([/* ... */]); $promise = $client->deleteOrganizationConformancePackAsync
([/* ... */]);
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Only a management account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added.
Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
Parameter Syntax
$result = $client->deleteOrganizationConformancePack([ 'OrganizationConformancePackName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- OrganizationConformancePackName
-
- Required: Yes
- Type: string
The name of organization conformance pack that you want to delete.
Result Syntax
[]
Result Details
Errors
- NoSuchOrganizationConformancePackException:
Config organization conformance pack that you passed in the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
DeletePendingAggregationRequest
$result = $client->deletePendingAggregationRequest
([/* ... */]); $promise = $client->deletePendingAggregationRequestAsync
([/* ... */]);
Deletes pending authorization requests for a specified aggregator account in a specified region.
Parameter Syntax
$result = $client->deletePendingAggregationRequest([ 'RequesterAccountId' => '<string>', // REQUIRED 'RequesterAwsRegion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- RequesterAccountId
-
- Required: Yes
- Type: string
The 12-digit account ID of the account requesting to aggregate data.
- RequesterAwsRegion
-
- Required: Yes
- Type: string
The region requesting to aggregate data.
Result Syntax
[]
Result Details
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
DeleteRemediationConfiguration
$result = $client->deleteRemediationConfiguration
([/* ... */]); $promise = $client->deleteRemediationConfigurationAsync
([/* ... */]);
Deletes the remediation configuration.
Parameter Syntax
$result = $client->deleteRemediationConfiguration([ 'ConfigRuleName' => '<string>', // REQUIRED 'ResourceType' => '<string>', ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule for which you want to delete remediation configuration.
- ResourceType
-
- Type: string
The type of a resource.
Result Syntax
[]
Result Details
Errors
- NoSuchRemediationConfigurationException:
You specified an Config rule without a remediation configuration.
- RemediationInProgressException:
Remediation action is in progress. You can either cancel execution in Amazon Web Services Systems Manager or wait and try again later.
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
DeleteRemediationExceptions
$result = $client->deleteRemediationExceptions
([/* ... */]); $promise = $client->deleteRemediationExceptionsAsync
([/* ... */]);
Deletes one or more remediation exceptions mentioned in the resource keys.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
Parameter Syntax
$result = $client->deleteRemediationExceptions([ 'ConfigRuleName' => '<string>', // REQUIRED 'ResourceKeys' => [ // REQUIRED [ 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], // ... ], ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule for which you want to delete remediation exception configuration.
- ResourceKeys
-
- Required: Yes
- Type: Array of RemediationExceptionResourceKey structures
An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
Result Syntax
[ 'FailedBatches' => [ [ 'FailedItems' => [ [ 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], // ... ], 'FailureMessage' => '<string>', ], // ... ], ]
Result Details
Members
- FailedBatches
-
- Type: Array of FailedDeleteRemediationExceptionsBatch structures
Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
Errors
- NoSuchRemediationExceptionException:
You tried to delete a remediation exception that does not exist.
DeleteResourceConfig
$result = $client->deleteResourceConfig
([/* ... */]); $promise = $client->deleteResourceConfigAsync
([/* ... */]);
Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.
Parameter Syntax
$result = $client->deleteResourceConfig([ 'ResourceId' => '<string>', // REQUIRED 'ResourceType' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceId
-
- Required: Yes
- Type: string
Unique identifier of the resource.
- ResourceType
-
- Required: Yes
- Type: string
The type of the resource.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoRunningConfigurationRecorderException:
There is no configuration recorder running.
DeleteRetentionConfiguration
$result = $client->deleteRetentionConfiguration
([/* ... */]); $promise = $client->deleteRetentionConfigurationAsync
([/* ... */]);
Deletes the retention configuration.
Parameter Syntax
$result = $client->deleteRetentionConfiguration([ 'RetentionConfigurationName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- RetentionConfigurationName
-
- Required: Yes
- Type: string
The name of the retention configuration to delete.
Result Syntax
[]
Result Details
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchRetentionConfigurationException:
You have specified a retention configuration that does not exist.
DeleteStoredQuery
$result = $client->deleteStoredQuery
([/* ... */]); $promise = $client->deleteStoredQueryAsync
([/* ... */]);
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
Parameter Syntax
$result = $client->deleteStoredQuery([ 'QueryName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- QueryName
-
- Required: Yes
- Type: string
The name of the query that you want to delete.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException:
You have specified a resource that does not exist.
DeliverConfigSnapshot
$result = $client->deliverConfigSnapshot
([/* ... */]); $promise = $client->deliverConfigSnapshotAsync
([/* ... */]);
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.
-
Notification of the start of the delivery.
-
Notification of the completion of the delivery, if the delivery was successfully completed.
-
Notification of delivery failure, if the delivery failed.
Parameter Syntax
$result = $client->deliverConfigSnapshot([ 'deliveryChannelName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- deliveryChannelName
-
- Required: Yes
- Type: string
The name of the delivery channel through which the snapshot is delivered.
Result Syntax
[ 'configSnapshotId' => '<string>', ]
Result Details
Members
- configSnapshotId
-
- Type: string
The ID of the snapshot that is being created.
Errors
- NoSuchDeliveryChannelException:
You have specified a delivery channel that does not exist.
- NoAvailableConfigurationRecorderException:
There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- NoRunningConfigurationRecorderException:
There is no configuration recorder running.
DescribeAggregateComplianceByConfigRules
$result = $client->describeAggregateComplianceByConfigRules
([/* ... */]); $promise = $client->describeAggregateComplianceByConfigRulesAsync
([/* ... */]);
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
The results can return an empty result page, but if you have a nextToken
, the results are displayed on the next page.
Parameter Syntax
$result = $client->describeAggregateComplianceByConfigRules([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Filters' => [ 'AccountId' => '<string>', 'AwsRegion' => '<string>', 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', 'ConfigRuleName' => '<string>', ], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Filters
-
- Type: ConfigRuleComplianceFilters structure
Filters the results by ConfigRuleComplianceFilters object.
- Limit
-
- Type: int
The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'AggregateComplianceByConfigRules' => [ [ 'AccountId' => '<string>', 'AwsRegion' => '<string>', 'Compliance' => [ 'ComplianceContributorCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', ], 'ConfigRuleName' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AggregateComplianceByConfigRules
-
- Type: Array of AggregateComplianceByConfigRule structures
Returns a list of AggregateComplianceByConfigRule object.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
DescribeAggregateComplianceByConformancePacks
$result = $client->describeAggregateComplianceByConformancePacks
([/* ... */]); $promise = $client->describeAggregateComplianceByConformancePacksAsync
([/* ... */]);
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
The results can return an empty result page, but if you have a nextToken
, the results are displayed on the next page.
Parameter Syntax
$result = $client->describeAggregateComplianceByConformancePacks([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Filters' => [ 'AccountId' => '<string>', 'AwsRegion' => '<string>', 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA', 'ConformancePackName' => '<string>', ], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Filters
-
- Type: AggregateConformancePackComplianceFilters structure
Filters the result by
AggregateConformancePackComplianceFilters
object. - Limit
-
- Type: int
The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'AggregateComplianceByConformancePacks' => [ [ 'AccountId' => '<string>', 'AwsRegion' => '<string>', 'Compliance' => [ 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA', 'CompliantRuleCount' => <integer>, 'NonCompliantRuleCount' => <integer>, 'TotalRuleCount' => <integer>, ], 'ConformancePackName' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AggregateComplianceByConformancePacks
-
- Type: Array of AggregateComplianceByConformancePack structures
Returns the
AggregateComplianceByConformancePack
object. - NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
DescribeAggregationAuthorizations
$result = $client->describeAggregationAuthorizations
([/* ... */]); $promise = $client->describeAggregationAuthorizationsAsync
([/* ... */]);
Returns a list of authorizations granted to various aggregator accounts and regions.
Parameter Syntax
$result = $client->describeAggregationAuthorizations([ 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'AggregationAuthorizations' => [ [ 'AggregationAuthorizationArn' => '<string>', 'AuthorizedAccountId' => '<string>', 'AuthorizedAwsRegion' => '<string>', 'CreationTime' => <DateTime>, ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AggregationAuthorizations
-
- Type: Array of AggregationAuthorization structures
Returns a list of authorizations granted to various aggregator accounts and regions.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidLimitException:
The specified limit is outside the allowable range.
DescribeComplianceByConfigRule
$result = $client->describeComplianceByConfigRule
([/* ... */]); $promise = $client->describeComplianceByConfigRuleAsync
([/* ... */]);
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.
If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA
. This result might indicate one of the following conditions:
-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the
config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
Parameter Syntax
$result = $client->describeComplianceByConfigRule([ 'ComplianceTypes' => ['<string>', ...], 'ConfigRuleNames' => ['<string>', ...], 'NextToken' => '<string>', ]);
Parameter Details
Members
- ComplianceTypes
-
- Type: Array of strings
Filters the results by compliance.
- ConfigRuleNames
-
- Type: Array of strings
Specify one or more Config rule names to filter the results by rule.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'ComplianceByConfigRules' => [ [ 'Compliance' => [ 'ComplianceContributorCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', ], 'ConfigRuleName' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ComplianceByConfigRules
-
- Type: Array of ComplianceByConfigRule structures
Indicates whether each of the specified Config rules is compliant.
- NextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
DescribeComplianceByResource
$result = $client->describeComplianceByResource
([/* ... */]); $promise = $client->describeComplianceByResourceAsync
([/* ... */]);
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA
. This result might indicate one of the following conditions about the rules that evaluate the resource:
-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the
config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
Parameter Syntax
$result = $client->describeComplianceByResource([ 'ComplianceTypes' => ['<string>', ...], 'Limit' => <integer>, 'NextToken' => '<string>', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ]);
Parameter Details
Members
- ComplianceTypes
-
- Type: Array of strings
Filters the results by compliance.
- Limit
-
- Type: int
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - ResourceId
-
- Type: string
The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for
ResourceType
. - ResourceType
-
- Type: string
The types of Amazon Web Services resources for which you want compliance information (for example,
AWS::EC2::Instance
). For this action, you can specify that the resource type is an Amazon Web Services account by specifyingAWS::::Account
.
Result Syntax
[ 'ComplianceByResources' => [ [ 'Compliance' => [ 'ComplianceContributorCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', ], 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ComplianceByResources
-
- Type: Array of ComplianceByResource structures
Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.
- NextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
DescribeConfigRuleEvaluationStatus
$result = $client->describeConfigRuleEvaluationStatus
([/* ... */]); $promise = $client->describeConfigRuleEvaluationStatusAsync
([/* ... */]);
Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
Parameter Syntax
$result = $client->describeConfigRuleEvaluationStatus([ 'ConfigRuleNames' => ['<string>', ...], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigRuleNames
-
- Type: Array of strings
The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.
- Limit
-
- Type: int
The number of rule evaluation results that you want returned.
This parameter is required if the rule limit for your account is more than the default of 1000 rules.
For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'ConfigRulesEvaluationStatus' => [ [ 'ConfigRuleArn' => '<string>', 'ConfigRuleId' => '<string>', 'ConfigRuleName' => '<string>', 'FirstActivatedTime' => <DateTime>, 'FirstEvaluationStarted' => true || false, 'LastDeactivatedTime' => <DateTime>, 'LastDebugLogDeliveryStatus' => '<string>', 'LastDebugLogDeliveryStatusReason' => '<string>', 'LastDebugLogDeliveryTime' => <DateTime>, 'LastErrorCode' => '<string>', 'LastErrorMessage' => '<string>', 'LastFailedEvaluationTime' => <DateTime>, 'LastFailedInvocationTime' => <DateTime>, 'LastSuccessfulEvaluationTime' => <DateTime>, 'LastSuccessfulInvocationTime' => <DateTime>, ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConfigRulesEvaluationStatus
-
- Type: Array of ConfigRuleEvaluationStatus structures
Status information about your Config managed rules.
- NextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
Errors
- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
DescribeConfigRules
$result = $client->describeConfigRules
([/* ... */]); $promise = $client->describeConfigRulesAsync
([/* ... */]);
Returns details about your Config rules.
Parameter Syntax
$result = $client->describeConfigRules([ 'ConfigRuleNames' => ['<string>', ...], 'Filters' => [ 'EvaluationMode' => 'DETECTIVE|PROACTIVE', ], 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigRuleNames
-
- Type: Array of strings
The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.
- Filters
-
- Type: DescribeConfigRulesFilters structure
Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'ConfigRules' => [ [ 'ConfigRuleArn' => '<string>', 'ConfigRuleId' => '<string>', 'ConfigRuleName' => '<string>', 'ConfigRuleState' => 'ACTIVE|DELETING|DELETING_RESULTS|EVALUATING', 'CreatedBy' => '<string>', 'Description' => '<string>', 'EvaluationModes' => [ [ 'Mode' => 'DETECTIVE|PROACTIVE', ], // ... ], 'InputParameters' => '<string>', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'Scope' => [ 'ComplianceResourceId' => '<string>', 'ComplianceResourceTypes' => ['<string>', ...], 'TagKey' => '<string>', 'TagValue' => '<string>', ], 'Source' => [ 'CustomPolicyDetails' => [ 'EnableDebugLogDelivery' => true || false, 'PolicyRuntime' => '<string>', 'PolicyText' => '<string>', ], 'Owner' => 'CUSTOM_LAMBDA|AWS|CUSTOM_POLICY', 'SourceDetails' => [ [ 'EventSource' => 'aws.config', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'MessageType' => 'ConfigurationItemChangeNotification|ConfigurationSnapshotDeliveryCompleted|ScheduledNotification|OversizedConfigurationItemChangeNotification', ], // ... ], 'SourceIdentifier' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConfigRules
-
- Type: Array of ConfigRule structures
The details about your Config rules.
- NextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
Errors
- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
DescribeConfigurationAggregatorSourcesStatus
$result = $client->describeConfigurationAggregatorSourcesStatus
([/* ... */]); $promise = $client->describeConfigurationAggregatorSourcesStatusAsync
([/* ... */]);
Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.
Parameter Syntax
$result = $client->describeConfigurationAggregatorSourcesStatus([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Limit' => <integer>, 'NextToken' => '<string>', 'UpdateStatus' => ['<string>', ...], ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Limit
-
- Type: int
The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - UpdateStatus
-
- Type: Array of strings
Filters the status type.
-
Valid value FAILED indicates errors while moving data.
-
Valid value SUCCEEDED indicates the data was successfully moved.
-
Valid value OUTDATED indicates the data is not the most recent.
Result Syntax
[ 'AggregatedSourceStatusList' => [ [ 'AwsRegion' => '<string>', 'LastErrorCode' => '<string>', 'LastErrorMessage' => '<string>', 'LastUpdateStatus' => 'FAILED|SUCCEEDED|OUTDATED', 'LastUpdateTime' => <DateTime>, 'SourceId' => '<string>', 'SourceType' => 'ACCOUNT|ORGANIZATION', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AggregatedSourceStatusList
-
- Type: Array of AggregatedSourceStatus structures
Returns an AggregatedSourceStatus object.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidLimitException:
The specified limit is outside the allowable range.
DescribeConfigurationAggregators
$result = $client->describeConfigurationAggregators
([/* ... */]); $promise = $client->describeConfigurationAggregatorsAsync
([/* ... */]);
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
Parameter Syntax
$result = $client->describeConfigurationAggregators([ 'ConfigurationAggregatorNames' => ['<string>', ...], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigurationAggregatorNames
-
- Type: Array of strings
The name of the configuration aggregators.
- Limit
-
- Type: int
The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'ConfigurationAggregators' => [ [ 'AccountAggregationSources' => [ [ 'AccountIds' => ['<string>', ...], 'AllAwsRegions' => true || false, 'AwsRegions' => ['<string>', ...], ], // ... ], 'ConfigurationAggregatorArn' => '<string>', 'ConfigurationAggregatorName' => '<string>', 'CreatedBy' => '<string>', 'CreationTime' => <DateTime>, 'LastUpdatedTime' => <DateTime>, 'OrganizationAggregationSource' => [ 'AllAwsRegions' => true || false, 'AwsRegions' => ['<string>', ...], 'RoleArn' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConfigurationAggregators
-
- Type: Array of ConfigurationAggregator structures
Returns a ConfigurationAggregators object.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidLimitException:
The specified limit is outside the allowable range.
DescribeConfigurationRecorderStatus
$result = $client->describeConfigurationRecorderStatus
([/* ... */]); $promise = $client->describeConfigurationRecorderStatusAsync
([/* ... */]);
Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
Parameter Syntax
$result = $client->describeConfigurationRecorderStatus([ 'ConfigurationRecorderNames' => ['<string>', ...], ]);
Parameter Details
Members
- ConfigurationRecorderNames
-
- Type: Array of strings
The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.
Result Syntax
[ 'ConfigurationRecordersStatus' => [ [ 'lastErrorCode' => '<string>', 'lastErrorMessage' => '<string>', 'lastStartTime' => <DateTime>, 'lastStatus' => 'Pending|Success|Failure', 'lastStatusChangeTime' => <DateTime>, 'lastStopTime' => <DateTime>, 'name' => '<string>', 'recording' => true || false, ], // ... ], ]
Result Details
Members
- ConfigurationRecordersStatus
-
- Type: Array of ConfigurationRecorderStatus structures
A list that contains status of the specified recorders.
Errors
- NoSuchConfigurationRecorderException:
You have specified a configuration recorder that does not exist.
DescribeConfigurationRecorders
$result = $client->describeConfigurationRecorders
([/* ... */]); $promise = $client->describeConfigurationRecordersAsync
([/* ... */]);
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.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
Parameter Syntax
$result = $client->describeConfigurationRecorders([ 'ConfigurationRecorderNames' => ['<string>', ...], ]);
Parameter Details
Members
- ConfigurationRecorderNames
-
- Type: Array of strings
A list of configuration recorder names.
Result Syntax
[ 'ConfigurationRecorders' => [ [ 'name' => '<string>', 'recordingGroup' => [ 'allSupported' => true || false, 'exclusionByResourceTypes' => [ 'resourceTypes' => ['<string>', ...], ], 'includeGlobalResourceTypes' => true || false, 'recordingStrategy' => [ 'useOnly' => 'ALL_SUPPORTED_RESOURCE_TYPES|INCLUSION_BY_RESOURCE_TYPES|EXCLUSION_BY_RESOURCE_TYPES', ], 'resourceTypes' => ['<string>', ...], ], 'recordingMode' => [ 'recordingFrequency' => 'CONTINUOUS|DAILY', 'recordingModeOverrides' => [ [ 'description' => '<string>', 'recordingFrequency' => 'CONTINUOUS|DAILY', 'resourceTypes' => ['<string>', ...], ], // ... ], ], 'roleARN' => '<string>', ], // ... ], ]
Result Details
Members
- ConfigurationRecorders
-
- Type: Array of ConfigurationRecorder structures
A list that contains the descriptions of the specified configuration recorders.
Errors
- NoSuchConfigurationRecorderException:
You have specified a configuration recorder that does not exist.
DescribeConformancePackCompliance
$result = $client->describeConformancePackCompliance
([/* ... */]); $promise = $client->describeConformancePackComplianceAsync
([/* ... */]);
Returns compliance details for each rule in that conformance pack.
You must provide exact rule names.
Parameter Syntax
$result = $client->describeConformancePackCompliance([ 'ConformancePackName' => '<string>', // REQUIRED 'Filters' => [ 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA', 'ConfigRuleNames' => ['<string>', ...], ], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConformancePackName
-
- Required: Yes
- Type: string
Name of the conformance pack.
- Filters
-
- Type: ConformancePackComplianceFilters structure
A
ConformancePackComplianceFilters
object. - Limit
-
- Type: int
The maximum number of Config rules within a conformance pack are returned on each page.
- NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Result Syntax
[ 'ConformancePackName' => '<string>', 'ConformancePackRuleComplianceList' => [ [ 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA', 'ConfigRuleName' => '<string>', 'Controls' => ['<string>', ...], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConformancePackName
-
- Required: Yes
- Type: string
Name of the conformance pack.
- ConformancePackRuleComplianceList
-
- Required: Yes
- Type: Array of ConformancePackRuleCompliance structures
Returns a list of
ConformancePackRuleCompliance
objects. - NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Errors
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleInConformancePackException:
Config rule that you passed in the filter does not exist.
- NoSuchConformancePackException:
You specified one or more conformance packs that do not exist.
DescribeConformancePackStatus
$result = $client->describeConformancePackStatus
([/* ... */]); $promise = $client->describeConformancePackStatusAsync
([/* ... */]);
Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
Parameter Syntax
$result = $client->describeConformancePackStatus([ 'ConformancePackNames' => ['<string>', ...], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConformancePackNames
-
- Type: Array of strings
Comma-separated list of conformance pack names.
- Limit
-
- Type: int
The maximum number of conformance packs status returned on each page.
- NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Result Syntax
[ 'ConformancePackStatusDetails' => [ [ 'ConformancePackArn' => '<string>', 'ConformancePackId' => '<string>', 'ConformancePackName' => '<string>', 'ConformancePackState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED', 'ConformancePackStatusReason' => '<string>', 'LastUpdateCompletedTime' => <DateTime>, 'LastUpdateRequestedTime' => <DateTime>, 'StackArn' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConformancePackStatusDetails
-
- Type: Array of ConformancePackStatusDetail structures
A list of
ConformancePackStatusDetail
objects. - NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Errors
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
DescribeConformancePacks
$result = $client->describeConformancePacks
([/* ... */]); $promise = $client->describeConformancePacksAsync
([/* ... */]);
Returns a list of one or more conformance packs.
Parameter Syntax
$result = $client->describeConformancePacks([ 'ConformancePackNames' => ['<string>', ...], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConformancePackNames
-
- Type: Array of strings
Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.
- Limit
-
- Type: int
The maximum number of conformance packs returned on each page.
- NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Result Syntax
[ 'ConformancePackDetails' => [ [ 'ConformancePackArn' => '<string>', 'ConformancePackId' => '<string>', 'ConformancePackInputParameters' => [ [ 'ParameterName' => '<string>', 'ParameterValue' => '<string>', ], // ... ], 'ConformancePackName' => '<string>', 'CreatedBy' => '<string>', 'DeliveryS3Bucket' => '<string>', 'DeliveryS3KeyPrefix' => '<string>', 'LastUpdateRequestedTime' => <DateTime>, 'TemplateSSMDocumentDetails' => [ 'DocumentName' => '<string>', 'DocumentVersion' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConformancePackDetails
-
- Type: Array of ConformancePackDetail structures
Returns a list of
ConformancePackDetail
objects. - NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Errors
- NoSuchConformancePackException:
You specified one or more conformance packs that do not exist.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
DescribeDeliveryChannelStatus
$result = $client->describeDeliveryChannelStatus
([/* ... */]); $promise = $client->describeDeliveryChannelStatusAsync
([/* ... */]);
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per region in your account.
Parameter Syntax
$result = $client->describeDeliveryChannelStatus([ 'DeliveryChannelNames' => ['<string>', ...], ]);
Parameter Details
Members
- DeliveryChannelNames
-
- Type: Array of strings
A list of delivery channel names.
Result Syntax
[ 'DeliveryChannelsStatus' => [ [ 'configHistoryDeliveryInfo' => [ 'lastAttemptTime' => <DateTime>, 'lastErrorCode' => '<string>', 'lastErrorMessage' => '<string>', 'lastStatus' => 'Success|Failure|Not_Applicable', 'lastSuccessfulTime' => <DateTime>, 'nextDeliveryTime' => <DateTime>, ], 'configSnapshotDeliveryInfo' => [ 'lastAttemptTime' => <DateTime>, 'lastErrorCode' => '<string>', 'lastErrorMessage' => '<string>', 'lastStatus' => 'Success|Failure|Not_Applicable', 'lastSuccessfulTime' => <DateTime>, 'nextDeliveryTime' => <DateTime>, ], 'configStreamDeliveryInfo' => [ 'lastErrorCode' => '<string>', 'lastErrorMessage' => '<string>', 'lastStatus' => 'Success|Failure|Not_Applicable', 'lastStatusChangeTime' => <DateTime>, ], 'name' => '<string>', ], // ... ], ]
Result Details
Members
- DeliveryChannelsStatus
-
- Type: Array of DeliveryChannelStatus structures
A list that contains the status of a specified delivery channel.
Errors
- NoSuchDeliveryChannelException:
You have specified a delivery channel that does not exist.
DescribeDeliveryChannels
$result = $client->describeDeliveryChannels
([/* ... */]); $promise = $client->describeDeliveryChannelsAsync
([/* ... */]);
Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per region in your account.
Parameter Syntax
$result = $client->describeDeliveryChannels([ 'DeliveryChannelNames' => ['<string>', ...], ]);
Parameter Details
Members
- DeliveryChannelNames
-
- Type: Array of strings
A list of delivery channel names.
Result Syntax
[ 'DeliveryChannels' => [ [ 'configSnapshotDeliveryProperties' => [ 'deliveryFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', ], 'name' => '<string>', 's3BucketName' => '<string>', 's3KeyPrefix' => '<string>', 's3KmsKeyArn' => '<string>', 'snsTopicARN' => '<string>', ], // ... ], ]
Result Details
Members
- DeliveryChannels
-
- Type: Array of DeliveryChannel structures
A list that contains the descriptions of the specified delivery channel.
Errors
- NoSuchDeliveryChannelException:
You have specified a delivery channel that does not exist.
DescribeOrganizationConfigRuleStatuses
$result = $client->describeOrganizationConfigRuleStatuses
([/* ... */]); $promise = $client->describeOrganizationConfigRuleStatusesAsync
([/* ... */]);
Provides organization Config rule deployment status for an organization.
The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
Parameter Syntax
$result = $client->describeOrganizationConfigRuleStatuses([ 'Limit' => <integer>, 'NextToken' => '<string>', 'OrganizationConfigRuleNames' => ['<string>', ...], ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of
OrganizationConfigRuleStatuses
returned on each page. If you do no specify a number, Config uses the default. The default is 100. - NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - OrganizationConfigRuleNames
-
- Type: Array of strings
The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.
Result Syntax
[ 'NextToken' => '<string>', 'OrganizationConfigRuleStatuses' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', 'LastUpdateTime' => <DateTime>, 'OrganizationConfigRuleName' => '<string>', 'OrganizationRuleStatus' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - OrganizationConfigRuleStatuses
-
- Type: Array of OrganizationConfigRuleStatus structures
A list of
OrganizationConfigRuleStatus
objects.
Errors
- NoSuchOrganizationConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
DescribeOrganizationConfigRules
$result = $client->describeOrganizationConfigRules
([/* ... */]); $promise = $client->describeOrganizationConfigRulesAsync
([/* ... */]);
Returns a list of organization Config rules.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
For accounts within an organization
If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules
and DescribeOrganizationConformancePacks
APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
Parameter Syntax
$result = $client->describeOrganizationConfigRules([ 'Limit' => <integer>, 'NextToken' => '<string>', 'OrganizationConfigRuleNames' => ['<string>', ...], ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - OrganizationConfigRuleNames
-
- Type: Array of strings
The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.
Result Syntax
[ 'NextToken' => '<string>', 'OrganizationConfigRules' => [ [ 'ExcludedAccounts' => ['<string>', ...], 'LastUpdateTime' => <DateTime>, 'OrganizationConfigRuleArn' => '<string>', 'OrganizationConfigRuleName' => '<string>', 'OrganizationCustomPolicyRuleMetadata' => [ 'DebugLogDeliveryAccounts' => ['<string>', ...], 'Description' => '<string>', 'InputParameters' => '<string>', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'OrganizationConfigRuleTriggerTypes' => ['<string>', ...], 'PolicyRuntime' => '<string>', 'ResourceIdScope' => '<string>', 'ResourceTypesScope' => ['<string>', ...], 'TagKeyScope' => '<string>', 'TagValueScope' => '<string>', ], 'OrganizationCustomRuleMetadata' => [ 'Description' => '<string>', 'InputParameters' => '<string>', 'LambdaFunctionArn' => '<string>', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'OrganizationConfigRuleTriggerTypes' => ['<string>', ...], 'ResourceIdScope' => '<string>', 'ResourceTypesScope' => ['<string>', ...], 'TagKeyScope' => '<string>', 'TagValueScope' => '<string>', ], 'OrganizationManagedRuleMetadata' => [ 'Description' => '<string>', 'InputParameters' => '<string>', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'ResourceIdScope' => '<string>', 'ResourceTypesScope' => ['<string>', ...], 'RuleIdentifier' => '<string>', 'TagKeyScope' => '<string>', 'TagValueScope' => '<string>', ], ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - OrganizationConfigRules
-
- Type: Array of OrganizationConfigRule structures
Returns a list of
OrganizationConfigRule
objects.
Errors
- NoSuchOrganizationConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidLimitException:
The specified limit is outside the allowable range.
- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
DescribeOrganizationConformancePackStatuses
$result = $client->describeOrganizationConformancePackStatuses
([/* ... */]); $promise = $client->describeOrganizationConformancePackStatusesAsync
([/* ... */]);
Provides organization conformance pack deployment status for an organization.
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
Parameter Syntax
$result = $client->describeOrganizationConformancePackStatuses([ 'Limit' => <integer>, 'NextToken' => '<string>', 'OrganizationConformancePackNames' => ['<string>', ...], ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.
- NextToken
-
- Type: string
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- OrganizationConformancePackNames
-
- Type: Array of strings
The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs.
Result Syntax
[ 'NextToken' => '<string>', 'OrganizationConformancePackStatuses' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', 'LastUpdateTime' => <DateTime>, 'OrganizationConformancePackName' => '<string>', 'Status' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- OrganizationConformancePackStatuses
-
- Type: Array of OrganizationConformancePackStatus structures
A list of
OrganizationConformancePackStatus
objects.
Errors
- NoSuchOrganizationConformancePackException:
Config organization conformance pack that you passed in the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
DescribeOrganizationConformancePacks
$result = $client->describeOrganizationConformancePacks
([/* ... */]); $promise = $client->describeOrganizationConformancePacksAsync
([/* ... */]);
Returns a list of organization conformance packs.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
For accounts within an organization
If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules
and DescribeOrganizationConformancePacks
APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
Parameter Syntax
$result = $client->describeOrganizationConformancePacks([ 'Limit' => <integer>, 'NextToken' => '<string>', 'OrganizationConformancePackNames' => ['<string>', ...], ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100.
- NextToken
-
- Type: string
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- OrganizationConformancePackNames
-
- Type: Array of strings
The name that you assign to an organization conformance pack.
Result Syntax
[ 'NextToken' => '<string>', 'OrganizationConformancePacks' => [ [ 'ConformancePackInputParameters' => [ [ 'ParameterName' => '<string>', 'ParameterValue' => '<string>', ], // ... ], 'DeliveryS3Bucket' => '<string>', 'DeliveryS3KeyPrefix' => '<string>', 'ExcludedAccounts' => ['<string>', ...], 'LastUpdateTime' => <DateTime>, 'OrganizationConformancePackArn' => '<string>', 'OrganizationConformancePackName' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- OrganizationConformancePacks
-
- Type: Array of OrganizationConformancePack structures
Returns a list of OrganizationConformancePacks objects.
Errors
- NoSuchOrganizationConformancePackException:
Config organization conformance pack that you passed in the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidLimitException:
The specified limit is outside the allowable range.
- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
DescribePendingAggregationRequests
$result = $client->describePendingAggregationRequests
([/* ... */]); $promise = $client->describePendingAggregationRequestsAsync
([/* ... */]);
Returns a list of all pending aggregation requests.
Parameter Syntax
$result = $client->describePendingAggregationRequests([ 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'NextToken' => '<string>', 'PendingAggregationRequests' => [ [ 'RequesterAccountId' => '<string>', 'RequesterAwsRegion' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - PendingAggregationRequests
-
- Type: Array of PendingAggregationRequest structures
Returns a PendingAggregationRequests object.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidLimitException:
The specified limit is outside the allowable range.
DescribeRemediationConfigurations
$result = $client->describeRemediationConfigurations
([/* ... */]); $promise = $client->describeRemediationConfigurationsAsync
([/* ... */]);
Returns the details of one or more remediation configurations.
Parameter Syntax
$result = $client->describeRemediationConfigurations([ 'ConfigRuleNames' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ConfigRuleNames
-
- Required: Yes
- Type: Array of strings
A list of Config rule names of remediation configurations for which you want details.
Result Syntax
[ 'RemediationConfigurations' => [ [ 'Arn' => '<string>', 'Automatic' => true || false, 'ConfigRuleName' => '<string>', 'CreatedByService' => '<string>', 'ExecutionControls' => [ 'SsmControls' => [ 'ConcurrentExecutionRatePercentage' => <integer>, 'ErrorPercentage' => <integer>, ], ], 'MaximumAutomaticAttempts' => <integer>, 'Parameters' => [ '<StringWithCharLimit256>' => [ 'ResourceValue' => [ 'Value' => 'RESOURCE_ID', ], 'StaticValue' => [ 'Values' => ['<string>', ...], ], ], // ... ], 'ResourceType' => '<string>', 'RetryAttemptSeconds' => <integer>, 'TargetId' => '<string>', 'TargetType' => 'SSM_DOCUMENT', 'TargetVersion' => '<string>', ], // ... ], ]
Result Details
Members
- RemediationConfigurations
-
- Type: Array of RemediationConfiguration structures
Returns a remediation configuration object.
Errors
There are no errors described for this operation.
DescribeRemediationExceptions
$result = $client->describeRemediationExceptions
([/* ... */]); $promise = $client->describeRemediationExceptionsAsync
([/* ... */]);
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
Parameter Syntax
$result = $client->describeRemediationExceptions([ 'ConfigRuleName' => '<string>', // REQUIRED 'Limit' => <integer>, 'NextToken' => '<string>', 'ResourceKeys' => [ [ 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], // ... ], ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule.
- Limit
-
- Type: int
The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response. - ResourceKeys
-
- Type: Array of RemediationExceptionResourceKey structures
An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
Result Syntax
[ 'NextToken' => '<string>', 'RemediationExceptions' => [ [ 'ConfigRuleName' => '<string>', 'ExpirationTime' => <DateTime>, 'Message' => '<string>', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response. - RemediationExceptions
-
- Type: Array of RemediationException structures
Returns a list of remediation exception objects.
Errors
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
DescribeRemediationExecutionStatus
$result = $client->describeRemediationExecutionStatus
([/* ... */]); $promise = $client->describeRemediationExecutionStatusAsync
([/* ... */]);
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.
Parameter Syntax
$result = $client->describeRemediationExecutionStatus([ 'ConfigRuleName' => '<string>', // REQUIRED 'Limit' => <integer>, 'NextToken' => '<string>', 'ResourceKeys' => [ [ 'resourceId' => '<string>', // REQUIRED 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
A list of Config rule names.
- Limit
-
- Type: int
The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - ResourceKeys
-
- Type: Array of ResourceKey structures
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
Result Syntax
[ 'NextToken' => '<string>', 'RemediationExecutionStatuses' => [ [ 'InvocationTime' => <DateTime>, 'LastUpdatedTime' => <DateTime>, 'ResourceKey' => [ 'resourceId' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', ], 'State' => 'QUEUED|IN_PROGRESS|SUCCEEDED|FAILED', 'StepDetails' => [ [ 'ErrorMessage' => '<string>', 'Name' => '<string>', 'StartTime' => <DateTime>, 'State' => 'SUCCEEDED|PENDING|FAILED', 'StopTime' => <DateTime>, ], // ... ], ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - RemediationExecutionStatuses
-
- Type: Array of RemediationExecutionStatus structures
Returns a list of remediation execution statuses objects.
Errors
- NoSuchRemediationConfigurationException:
You specified an Config rule without a remediation configuration.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
DescribeRetentionConfigurations
$result = $client->describeRetentionConfigurations
([/* ... */]); $promise = $client->describeRetentionConfigurationsAsync
([/* ... */]);
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
Parameter Syntax
$result = $client->describeRetentionConfigurations([ 'NextToken' => '<string>', 'RetentionConfigurationNames' => ['<string>', ...], ]);
Parameter Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - RetentionConfigurationNames
-
- Type: Array of strings
A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
Result Syntax
[ 'NextToken' => '<string>', 'RetentionConfigurations' => [ [ 'Name' => '<string>', 'RetentionPeriodInDays' => <integer>, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - RetentionConfigurations
-
- Type: Array of RetentionConfiguration structures
Returns a retention configuration object.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchRetentionConfigurationException:
You have specified a retention configuration that does not exist.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
GetAggregateComplianceDetailsByConfigRule
$result = $client->getAggregateComplianceDetailsByConfigRule
([/* ... */]); $promise = $client->getAggregateComplianceDetailsByConfigRuleAsync
([/* ... */]);
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
The results can return an empty result page. But if you have a nextToken
, the results are displayed on the next page.
Parameter Syntax
$result = $client->getAggregateComplianceDetailsByConfigRule([ 'AccountId' => '<string>', // REQUIRED 'AwsRegion' => '<string>', // REQUIRED 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', 'ConfigRuleName' => '<string>', // REQUIRED 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The 12-digit account ID of the source account.
- AwsRegion
-
- Required: Yes
- Type: string
The source region from where the data is aggregated.
- ComplianceType
-
- Type: string
The resource compliance status.
For the
GetAggregateComplianceDetailsByConfigRuleRequest
data type, Config supports only theCOMPLIANT
andNON_COMPLIANT
. Config does not support theNOT_APPLICABLE
andINSUFFICIENT_DATA
values. - ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule for which you want compliance information.
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Limit
-
- Type: int
The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'AggregateEvaluationResults' => [ [ 'AccountId' => '<string>', 'Annotation' => '<string>', 'AwsRegion' => '<string>', 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', 'ConfigRuleInvokedTime' => <DateTime>, 'EvaluationResultIdentifier' => [ 'EvaluationResultQualifier' => [ 'ConfigRuleName' => '<string>', 'EvaluationMode' => 'DETECTIVE|PROACTIVE', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], 'OrderingTimestamp' => <DateTime>, 'ResourceEvaluationId' => '<string>', ], 'ResultRecordedTime' => <DateTime>, ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AggregateEvaluationResults
-
- Type: Array of AggregateEvaluationResult structures
Returns an AggregateEvaluationResults object.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
GetAggregateConfigRuleComplianceSummary
$result = $client->getAggregateConfigRuleComplianceSummary
([/* ... */]); $promise = $client->getAggregateConfigRuleComplianceSummaryAsync
([/* ... */]);
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Parameter Syntax
$result = $client->getAggregateConfigRuleComplianceSummary([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Filters' => [ 'AccountId' => '<string>', 'AwsRegion' => '<string>', ], 'GroupByKey' => 'ACCOUNT_ID|AWS_REGION', 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Filters
-
- Type: ConfigRuleComplianceSummaryFilters structure
Filters the results based on the ConfigRuleComplianceSummaryFilters object.
- GroupByKey
-
- Type: string
Groups the result based on ACCOUNT_ID or AWS_REGION.
- Limit
-
- Type: int
The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'AggregateComplianceCounts' => [ [ 'ComplianceSummary' => [ 'ComplianceSummaryTimestamp' => <DateTime>, 'CompliantResourceCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], 'NonCompliantResourceCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], ], 'GroupName' => '<string>', ], // ... ], 'GroupByKey' => '<string>', 'NextToken' => '<string>', ]
Result Details
Members
- AggregateComplianceCounts
-
- Type: Array of AggregateComplianceCount structures
Returns a list of AggregateComplianceCounts object.
- GroupByKey
-
- Type: string
Groups the result based on ACCOUNT_ID or AWS_REGION.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
GetAggregateConformancePackComplianceSummary
$result = $client->getAggregateConformancePackComplianceSummary
([/* ... */]); $promise = $client->getAggregateConformancePackComplianceSummaryAsync
([/* ... */]);
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Parameter Syntax
$result = $client->getAggregateConformancePackComplianceSummary([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Filters' => [ 'AccountId' => '<string>', 'AwsRegion' => '<string>', ], 'GroupByKey' => 'ACCOUNT_ID|AWS_REGION', 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Filters
-
- Type: AggregateConformancePackComplianceSummaryFilters structure
Filters the results based on the
AggregateConformancePackComplianceSummaryFilters
object. - GroupByKey
-
- Type: string
Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
- Limit
-
- Type: int
The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'AggregateConformancePackComplianceSummaries' => [ [ 'ComplianceSummary' => [ 'CompliantConformancePackCount' => <integer>, 'NonCompliantConformancePackCount' => <integer>, ], 'GroupName' => '<string>', ], // ... ], 'GroupByKey' => '<string>', 'NextToken' => '<string>', ]
Result Details
Members
- AggregateConformancePackComplianceSummaries
-
- Type: Array of AggregateConformancePackComplianceSummary structures
Returns a list of
AggregateConformancePackComplianceSummary
object. - GroupByKey
-
- Type: string
Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
GetAggregateDiscoveredResourceCounts
$result = $client->getAggregateDiscoveredResourceCounts
([/* ... */]); $promise = $client->getAggregateDiscoveredResourceCountsAsync
([/* ... */]);
Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
Parameter Syntax
$result = $client->getAggregateDiscoveredResourceCounts([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Filters' => [ 'AccountId' => '<string>', 'Region' => '<string>', 'ResourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', ], 'GroupByKey' => 'RESOURCE_TYPE|ACCOUNT_ID|AWS_REGION', 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Filters
-
- Type: ResourceCountFilters structure
Filters the results based on the
ResourceCountFilters
object. - GroupByKey
-
- Type: string
The key to group the resource counts.
- Limit
-
- Type: int
The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'GroupByKey' => '<string>', 'GroupedResourceCounts' => [ [ 'GroupName' => '<string>', 'ResourceCount' => <integer>, ], // ... ], 'NextToken' => '<string>', 'TotalDiscoveredResources' => <integer>, ]
Result Details
Members
- GroupByKey
-
- Type: string
The key passed into the request object. If
GroupByKey
is not provided, the result will be empty. - GroupedResourceCounts
-
- Type: Array of GroupedResourceCount structures
Returns a list of GroupedResourceCount objects.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - TotalDiscoveredResources
-
- Required: Yes
- Type: long (int|float)
The total number of resources that are present in an aggregator with the filters that you provide.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
GetAggregateResourceConfig
$result = $client->getAggregateResourceConfig
([/* ... */]); $promise = $client->getAggregateResourceConfigAsync
([/* ... */]);
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
Parameter Syntax
$result = $client->getAggregateResourceConfig([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'ResourceIdentifier' => [ // REQUIRED 'ResourceId' => '<string>', // REQUIRED 'ResourceName' => '<string>', 'ResourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', // REQUIRED 'SourceAccountId' => '<string>', // REQUIRED 'SourceRegion' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- ResourceIdentifier
-
- Required: Yes
- Type: AggregateResourceIdentifier structure
An object that identifies aggregate resource.
Result Syntax
[ 'ConfigurationItem' => [ 'accountId' => '<string>', 'arn' => '<string>', 'availabilityZone' => '<string>', 'awsRegion' => '<string>', 'configuration' => '<string>', 'configurationItemCaptureTime' => <DateTime>, 'configurationItemDeliveryTime' => <DateTime>, 'configurationItemMD5Hash' => '<string>', 'configurationItemStatus' => 'OK|ResourceDiscovered|ResourceNotRecorded|ResourceDeleted|ResourceDeletedNotRecorded', 'configurationStateId' => '<string>', 'recordingFrequency' => 'CONTINUOUS|DAILY', 'relatedEvents' => ['<string>', ...], 'relationships' => [ [ 'relationshipName' => '<string>', 'resourceId' => '<string>', 'resourceName' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', ], // ... ], 'resourceCreationTime' => <DateTime>, 'resourceId' => '<string>', 'resourceName' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', 'supplementaryConfiguration' => ['<string>', ...], 'tags' => ['<string>', ...], 'version' => '<string>', ], ]
Result Details
Members
- ConfigurationItem
-
- Type: ConfigurationItem structure
Returns a
ConfigurationItem
object.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
- OversizedConfigurationItemException:
The configuration item size is outside the allowable range.
- ResourceNotDiscoveredException:
You have specified a resource that is either unknown or has not been discovered.
GetComplianceDetailsByConfigRule
$result = $client->getComplianceDetailsByConfigRule
([/* ... */]); $promise = $client->getComplianceDetailsByConfigRuleAsync
([/* ... */]);
Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
Parameter Syntax
$result = $client->getComplianceDetailsByConfigRule([ 'ComplianceTypes' => ['<string>', ...], 'ConfigRuleName' => '<string>', // REQUIRED 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ComplianceTypes
-
- Type: Array of strings
Filters the results by compliance.
INSUFFICIENT_DATA
is a validComplianceType
that is returned when an Config rule cannot be evaluated. However,INSUFFICIENT_DATA
cannot be used as aComplianceType
for filtering results. - ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule for which you want compliance information.
- Limit
-
- Type: int
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'EvaluationResults' => [ [ 'Annotation' => '<string>', 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', 'ConfigRuleInvokedTime' => <DateTime>, 'EvaluationResultIdentifier' => [ 'EvaluationResultQualifier' => [ 'ConfigRuleName' => '<string>', 'EvaluationMode' => 'DETECTIVE|PROACTIVE', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], 'OrderingTimestamp' => <DateTime>, 'ResourceEvaluationId' => '<string>', ], 'ResultRecordedTime' => <DateTime>, 'ResultToken' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- EvaluationResults
-
- Type: Array of EvaluationResult structures
Indicates whether the Amazon Web Services resource complies with the specified Config rule.
- NextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
GetComplianceDetailsByResource
$result = $client->getComplianceDetailsByResource
([/* ... */]); $promise = $client->getComplianceDetailsByResourceAsync
([/* ... */]);
Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.
Parameter Syntax
$result = $client->getComplianceDetailsByResource([ 'ComplianceTypes' => ['<string>', ...], 'NextToken' => '<string>', 'ResourceEvaluationId' => '<string>', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ]);
Parameter Details
Members
- ComplianceTypes
-
- Type: Array of strings
Filters the results by compliance.
INSUFFICIENT_DATA
is a validComplianceType
that is returned when an Config rule cannot be evaluated. However,INSUFFICIENT_DATA
cannot be used as aComplianceType
for filtering results. - NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - ResourceEvaluationId
-
- Type: string
The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.
You need to only provide either a
ResourceEvaluationID
or aResourceID
andResourceType
. - ResourceId
-
- Type: string
The ID of the Amazon Web Services resource for which you want compliance information.
- ResourceType
-
- Type: string
The type of the Amazon Web Services resource for which you want compliance information.
Result Syntax
[ 'EvaluationResults' => [ [ 'Annotation' => '<string>', 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', 'ConfigRuleInvokedTime' => <DateTime>, 'EvaluationResultIdentifier' => [ 'EvaluationResultQualifier' => [ 'ConfigRuleName' => '<string>', 'EvaluationMode' => 'DETECTIVE|PROACTIVE', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], 'OrderingTimestamp' => <DateTime>, 'ResourceEvaluationId' => '<string>', ], 'ResultRecordedTime' => <DateTime>, 'ResultToken' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- EvaluationResults
-
- Type: Array of EvaluationResult structures
Indicates whether the specified Amazon Web Services resource complies each Config rule.
- NextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
GetComplianceSummaryByConfigRule
$result = $client->getComplianceSummaryByConfigRule
([/* ... */]); $promise = $client->getComplianceSummaryByConfigRuleAsync
([/* ... */]);
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
Parameter Syntax
$result = $client->getComplianceSummaryByConfigRule([ ]);
Parameter Details
Members
Result Syntax
[ 'ComplianceSummary' => [ 'ComplianceSummaryTimestamp' => <DateTime>, 'CompliantResourceCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], 'NonCompliantResourceCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], ], ]
Result Details
Members
- ComplianceSummary
-
- Type: ComplianceSummary structure
The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.
Errors
There are no errors described for this operation.
GetComplianceSummaryByResourceType
$result = $client->getComplianceSummaryByResourceType
([/* ... */]); $promise = $client->getComplianceSummaryByResourceTypeAsync
([/* ... */]);
Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
Parameter Syntax
$result = $client->getComplianceSummaryByResourceType([ 'ResourceTypes' => ['<string>', ...], ]);
Parameter Details
Members
- ResourceTypes
-
- Type: Array of strings
Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.
For this request, you can specify an Amazon Web Services resource type such as
AWS::EC2::Instance
. You can specify that the resource type is an Amazon Web Services account by specifyingAWS::::Account
.
Result Syntax
[ 'ComplianceSummariesByResourceType' => [ [ 'ComplianceSummary' => [ 'ComplianceSummaryTimestamp' => <DateTime>, 'CompliantResourceCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], 'NonCompliantResourceCount' => [ 'CapExceeded' => true || false, 'CappedCount' => <integer>, ], ], 'ResourceType' => '<string>', ], // ... ], ]
Result Details
Members
- ComplianceSummariesByResourceType
-
- Type: Array of ComplianceSummaryByResourceType structures
The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
GetConformancePackComplianceDetails
$result = $client->getConformancePackComplianceDetails
([/* ... */]); $promise = $client->getConformancePackComplianceDetailsAsync
([/* ... */]);
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
Parameter Syntax
$result = $client->getConformancePackComplianceDetails([ 'ConformancePackName' => '<string>', // REQUIRED 'Filters' => [ 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA', 'ConfigRuleNames' => ['<string>', ...], 'ResourceIds' => ['<string>', ...], 'ResourceType' => '<string>', ], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConformancePackName
-
- Required: Yes
- Type: string
Name of the conformance pack.
- Filters
-
- Type: ConformancePackEvaluationFilters structure
A
ConformancePackEvaluationFilters
object. - Limit
-
- Type: int
The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.
- NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Result Syntax
[ 'ConformancePackName' => '<string>', 'ConformancePackRuleEvaluationResults' => [ [ 'Annotation' => '<string>', 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA', 'ConfigRuleInvokedTime' => <DateTime>, 'EvaluationResultIdentifier' => [ 'EvaluationResultQualifier' => [ 'ConfigRuleName' => '<string>', 'EvaluationMode' => 'DETECTIVE|PROACTIVE', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], 'OrderingTimestamp' => <DateTime>, 'ResourceEvaluationId' => '<string>', ], 'ResultRecordedTime' => <DateTime>, ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConformancePackName
-
- Required: Yes
- Type: string
Name of the conformance pack.
- ConformancePackRuleEvaluationResults
-
- Type: Array of ConformancePackEvaluationResult structures
Returns a list of
ConformancePackEvaluationResult
objects. - NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Errors
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConformancePackException:
You specified one or more conformance packs that do not exist.
- NoSuchConfigRuleInConformancePackException:
Config rule that you passed in the filter does not exist.
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
GetConformancePackComplianceSummary
$result = $client->getConformancePackComplianceSummary
([/* ... */]); $promise = $client->getConformancePackComplianceSummaryAsync
([/* ... */]);
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
Parameter Syntax
$result = $client->getConformancePackComplianceSummary([ 'ConformancePackNames' => ['<string>', ...], // REQUIRED 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConformancePackNames
-
- Required: Yes
- Type: Array of strings
Names of conformance packs.
- Limit
-
- Type: int
The maximum number of conformance packs returned on each page.
- NextToken
-
- Type: string
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'ConformancePackComplianceSummaryList' => [ [ 'ConformancePackComplianceStatus' => 'COMPLIANT|NON_COMPLIANT|INSUFFICIENT_DATA', 'ConformancePackName' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConformancePackComplianceSummaryList
-
- Type: Array of ConformancePackComplianceSummary structures
A list of
ConformancePackComplianceSummary
objects. - NextToken
-
- Type: string
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Errors
- NoSuchConformancePackException:
You specified one or more conformance packs that do not exist.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
GetCustomRulePolicy
$result = $client->getCustomRulePolicy
([/* ... */]); $promise = $client->getCustomRulePolicyAsync
([/* ... */]);
Returns the policy definition containing the logic for your Config Custom Policy rule.
Parameter Syntax
$result = $client->getCustomRulePolicy([ 'ConfigRuleName' => '<string>', ]);
Parameter Details
Members
- ConfigRuleName
-
- Type: string
The name of your Config Custom Policy rule.
Result Syntax
[ 'PolicyText' => '<string>', ]
Result Details
Members
- PolicyText
-
- Type: string
The policy definition containing the logic for your Config Custom Policy rule.
Errors
- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
GetDiscoveredResourceCounts
$result = $client->getDiscoveredResourceCounts
([/* ... */]); $promise = $client->getDiscoveredResourceCountsAsync
([/* ... */]);
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
-
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
-
You make a call to the
GetDiscoveredResourceCounts
action and specify that you want all resource types. -
Config returns the following:
-
The resource types (EC2 instances, IAM users, and S3 buckets).
-
The number of each resource type (25, 20, and 15).
-
The total number of all resources (60).
-
The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the limit
parameter. The response includes a nextToken
string. To get the next page of results, run the request again and specify the string for the nextToken
parameter.
If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
-
You are a new Config customer.
-
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
Parameter Syntax
$result = $client->getDiscoveredResourceCounts([ 'limit' => <integer>, 'nextToken' => '<string>', 'resourceTypes' => ['<string>', ...], ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- nextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - resourceTypes
-
- Type: Array of strings
The comma-separated list that specifies the resource types that you want Config to return (for example,
"AWS::EC2::Instance"
,"AWS::IAM::User"
).If a value for
resourceTypes
is not specified, Config returns all resource types that Config is recording in the region for your account.If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.
Result Syntax
[ 'nextToken' => '<string>', 'resourceCounts' => [ [ 'count' => <integer>, 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', ], // ... ], 'totalDiscoveredResources' => <integer>, ]
Result Details
Members
- nextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
- resourceCounts
-
- Type: Array of ResourceCount structures
The list of
ResourceCount
objects. Each object is listed in descending order by the number of resources. - totalDiscoveredResources
-
- Type: long (int|float)
The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.
Example
-
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.
-
You make a call to the
GetDiscoveredResourceCounts
action and specify the resource type,"AWS::EC2::Instances"
, in the request. -
Config returns 25 for
totalDiscoveredResources
.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
GetOrganizationConfigRuleDetailedStatus
$result = $client->getOrganizationConfigRuleDetailedStatus
([/* ... */]); $promise = $client->getOrganizationConfigRuleDetailedStatusAsync
([/* ... */]);
Returns detailed status for each member account within an organization for a given organization Config rule.
Parameter Syntax
$result = $client->getOrganizationConfigRuleDetailedStatus([ 'Filters' => [ 'AccountId' => '<string>', 'MemberAccountRuleStatus' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], 'Limit' => <integer>, 'NextToken' => '<string>', 'OrganizationConfigRuleName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Filters
-
- Type: StatusDetailFilters structure
A
StatusDetailFilters
object. - Limit
-
- Type: int
The maximum number of
OrganizationConfigRuleDetailedStatus
returned on each page. If you do not specify a number, Config uses the default. The default is 100. - NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - OrganizationConfigRuleName
-
- Required: Yes
- Type: string
The name of your organization Config rule for which you want status details for member accounts.
Result Syntax
[ 'NextToken' => '<string>', 'OrganizationConfigRuleDetailedStatus' => [ [ 'AccountId' => '<string>', 'ConfigRuleName' => '<string>', 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', 'LastUpdateTime' => <DateTime>, 'MemberAccountRuleStatus' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - OrganizationConfigRuleDetailedStatus
-
- Type: Array of MemberAccountStatus structures
A list of
MemberAccountStatus
objects.
Errors
- NoSuchOrganizationConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
GetOrganizationConformancePackDetailedStatus
$result = $client->getOrganizationConformancePackDetailedStatus
([/* ... */]); $promise = $client->getOrganizationConformancePackDetailedStatusAsync
([/* ... */]);
Returns detailed status for each member account within an organization for a given organization conformance pack.
Parameter Syntax
$result = $client->getOrganizationConformancePackDetailedStatus([ 'Filters' => [ 'AccountId' => '<string>', 'Status' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], 'Limit' => <integer>, 'NextToken' => '<string>', 'OrganizationConformancePackName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Filters
-
- Type: OrganizationResourceDetailedStatusFilters structure
An
OrganizationResourceDetailedStatusFilters
object. - Limit
-
- Type: int
The maximum number of
OrganizationConformancePackDetailedStatuses
returned on each page. If you do not specify a number, Config uses the default. The default is 100. - NextToken
-
- Type: string
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- OrganizationConformancePackName
-
- Required: Yes
- Type: string
The name of organization conformance pack for which you want status details for member accounts.
Result Syntax
[ 'NextToken' => '<string>', 'OrganizationConformancePackDetailedStatuses' => [ [ 'AccountId' => '<string>', 'ConformancePackName' => '<string>', 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', 'LastUpdateTime' => <DateTime>, 'Status' => 'CREATE_SUCCESSFUL|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_SUCCESSFUL|DELETE_FAILED|DELETE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- OrganizationConformancePackDetailedStatuses
-
- Type: Array of OrganizationConformancePackDetailedStatus structures
A list of
OrganizationConformancePackDetailedStatus
objects.
Errors
- NoSuchOrganizationConformancePackException:
Config organization conformance pack that you passed in the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
GetOrganizationCustomRulePolicy
$result = $client->getOrganizationCustomRulePolicy
([/* ... */]); $promise = $client->getOrganizationCustomRulePolicyAsync
([/* ... */]);
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
Parameter Syntax
$result = $client->getOrganizationCustomRulePolicy([ 'OrganizationConfigRuleName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- OrganizationConfigRuleName
-
- Required: Yes
- Type: string
The name of your organization Config Custom Policy rule.
Result Syntax
[ 'PolicyText' => '<string>', ]
Result Details
Members
- PolicyText
-
- Type: string
The policy definition containing the logic for your organization Config Custom Policy rule.
Errors
- NoSuchOrganizationConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
GetResourceConfigHistory
$result = $client->getResourceConfigHistory
([/* ... */]); $promise = $client->getResourceConfigHistoryAsync
([/* ... */]);
For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance
resource type. For more information, see Selecting Which Resources Config Records.
Returns a list of ConfigurationItems
for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems
between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems
for the specified retention period.
The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the limit
parameter. The response includes a nextToken
string. To get the next page of results, run the request again and specify the string for the nextToken
parameter.
Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit
. In such cases, you can make another call, using the nextToken
.
Parameter Syntax
$result = $client->getResourceConfigHistory([ 'chronologicalOrder' => 'Reverse|Forward', 'earlierTime' => <integer || string || DateTime>, 'laterTime' => <integer || string || DateTime>, 'limit' => <integer>, 'nextToken' => '<string>', 'resourceId' => '<string>', // REQUIRED 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', // REQUIRED ]);
Parameter Details
Members
- chronologicalOrder
-
- Type: string
The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.
- earlierTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The chronologically earliest time in the time range for which the history requested. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.
- laterTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The chronologically latest time in the time range for which the history requested. If not specified, current time is taken.
- limit
-
- Type: int
The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- nextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - resourceId
-
- Required: Yes
- Type: string
The ID of the resource (for example.,
sg-xxxxxx
). - resourceType
-
- Required: Yes
- Type: string
The resource type.
Result Syntax
[ 'configurationItems' => [ [ 'accountId' => '<string>', 'arn' => '<string>', 'availabilityZone' => '<string>', 'awsRegion' => '<string>', 'configuration' => '<string>', 'configurationItemCaptureTime' => <DateTime>, 'configurationItemDeliveryTime' => <DateTime>, 'configurationItemMD5Hash' => '<string>', 'configurationItemStatus' => 'OK|ResourceDiscovered|ResourceNotRecorded|ResourceDeleted|ResourceDeletedNotRecorded', 'configurationStateId' => '<string>', 'recordingFrequency' => 'CONTINUOUS|DAILY', 'relatedEvents' => ['<string>', ...], 'relationships' => [ [ 'relationshipName' => '<string>', 'resourceId' => '<string>', 'resourceName' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', ], // ... ], 'resourceCreationTime' => <DateTime>, 'resourceId' => '<string>', 'resourceName' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', 'supplementaryConfiguration' => ['<string>', ...], 'tags' => ['<string>', ...], 'version' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- configurationItems
-
- Type: Array of ConfigurationItem structures
A list that contains the configuration history of one or more resources.
- nextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidTimeRangeException:
The specified time range is not valid. The earlier time is not chronologically before the later time.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoAvailableConfigurationRecorderException:
There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- ResourceNotDiscoveredException:
You have specified a resource that is either unknown or has not been discovered.
GetResourceEvaluationSummary
$result = $client->getResourceEvaluationSummary
([/* ... */]); $promise = $client->getResourceEvaluationSummaryAsync
([/* ... */]);
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.
To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.
Parameter Syntax
$result = $client->getResourceEvaluationSummary([ 'ResourceEvaluationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceEvaluationId
-
- Required: Yes
- Type: string
The unique
ResourceEvaluationId
of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.
Result Syntax
[ 'Compliance' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', 'EvaluationContext' => [ 'EvaluationContextIdentifier' => '<string>', ], 'EvaluationMode' => 'DETECTIVE|PROACTIVE', 'EvaluationStartTimestamp' => <DateTime>, 'EvaluationStatus' => [ 'FailureReason' => '<string>', 'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED', ], 'ResourceDetails' => [ 'ResourceConfiguration' => '<string>', 'ResourceConfigurationSchemaType' => 'CFN_RESOURCE_SCHEMA', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], 'ResourceEvaluationId' => '<string>', ]
Result Details
Members
- Compliance
-
- Type: string
The compliance status of the resource evaluation summary.
- EvaluationContext
-
- Type: EvaluationContext structure
Returns an
EvaluationContext
object. - EvaluationMode
-
- Type: string
Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.
- EvaluationStartTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start timestamp when Config rule starts evaluating compliance for the provided resource details.
- EvaluationStatus
-
- Type: EvaluationStatus structure
Returns an
EvaluationStatus
object. - ResourceDetails
-
- Type: ResourceDetails structure
Returns a
ResourceDetails
object. - ResourceEvaluationId
-
- Type: string
The unique
ResourceEvaluationId
of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.
Errors
- ResourceNotFoundException:
You have specified a resource that does not exist.
GetStoredQuery
$result = $client->getStoredQuery
([/* ... */]); $promise = $client->getStoredQueryAsync
([/* ... */]);
Returns the details of a specific stored query.
Parameter Syntax
$result = $client->getStoredQuery([ 'QueryName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- QueryName
-
- Required: Yes
- Type: string
The name of the query.
Result Syntax
[ 'StoredQuery' => [ 'Description' => '<string>', 'Expression' => '<string>', 'QueryArn' => '<string>', 'QueryId' => '<string>', 'QueryName' => '<string>', ], ]
Result Details
Members
- StoredQuery
-
- Type: StoredQuery structure
Returns a
StoredQuery
object.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException:
You have specified a resource that does not exist.
ListAggregateDiscoveredResources
$result = $client->listAggregateDiscoveredResources
([/* ... */]); $promise = $client->listAggregateDiscoveredResourcesAsync
([/* ... */]);
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.
For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance
then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.
Parameter Syntax
$result = $client->listAggregateDiscoveredResources([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Filters' => [ 'AccountId' => '<string>', 'Region' => '<string>', 'ResourceId' => '<string>', 'ResourceName' => '<string>', ], 'Limit' => <integer>, 'NextToken' => '<string>', 'ResourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', // REQUIRED ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Filters
-
- Type: ResourceFilters structure
Filters the results based on the
ResourceFilters
object. - Limit
-
- Type: int
The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - ResourceType
-
- Required: Yes
- Type: string
The type of resources that you want Config to list in the response.
Result Syntax
[ 'NextToken' => '<string>', 'ResourceIdentifiers' => [ [ 'ResourceId' => '<string>', 'ResourceName' => '<string>', 'ResourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', 'SourceAccountId' => '<string>', 'SourceRegion' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - ResourceIdentifiers
-
- Type: Array of AggregateResourceIdentifier structures
Returns a list of
ResourceIdentifiers
objects.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
ListConformancePackComplianceScores
$result = $client->listConformancePackComplianceScores
([/* ... */]); $promise = $client->listConformancePackComplianceScoresAsync
([/* ... */]);
Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.
Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA
.
Parameter Syntax
$result = $client->listConformancePackComplianceScores([ 'Filters' => [ 'ConformancePackNames' => ['<string>', ...], // REQUIRED ], 'Limit' => <integer>, 'NextToken' => '<string>', 'SortBy' => 'SCORE', 'SortOrder' => 'ASCENDING|DESCENDING', ]);
Parameter Details
Members
- Filters
-
- Type: ConformancePackComplianceScoresFilters structure
Filters the results based on the
ConformancePackComplianceScoresFilters
. - Limit
-
- Type: int
The maximum number of conformance pack compliance scores returned on each page.
- NextToken
-
- Type: string
The
nextToken
string in a prior request that you can use to get the paginated response for the next set of conformance pack compliance scores. - SortBy
-
- Type: string
Sorts your conformance pack compliance scores in either ascending or descending order, depending on
SortOrder
.By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Enter
SCORE
, to sort conformance pack compliance scores by the numerical value of the compliance score. - SortOrder
-
- Type: string
Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.
By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter
DESCENDING
.You can sort conformance pack compliance scores by the numerical value of the compliance score by entering
SCORE
in theSortBy
action. When compliance scores are sorted bySCORE
, conformance packs with a compliance score ofINSUFFICIENT_DATA
will be last when sorting by ascending order and first when sorting by descending order.
Result Syntax
[ 'ConformancePackComplianceScores' => [ [ 'ConformancePackName' => '<string>', 'LastUpdatedTime' => <DateTime>, 'Score' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConformancePackComplianceScores
-
- Required: Yes
- Type: Array of ConformancePackComplianceScore structures
A list of
ConformancePackComplianceScore
objects. - NextToken
-
- Type: string
The
nextToken
string that you can use to get the next page of results in a paginated response.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
ListDiscoveredResources
$result = $client->listDiscoveredResources
([/* ... */]); $promise = $client->listDiscoveredResourcesAsync
([/* ... */]);
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
You can specify either resource IDs or a resource name, but not both, in the same request.
The response is paginated. By default, Config lists 100 resource identifiers on each page. You can customize this number with the limit
parameter. The response includes a nextToken
string. To get the next page of results, run the request again and specify the string for the nextToken
parameter.
Parameter Syntax
$result = $client->listDiscoveredResources([ 'includeDeletedResources' => true || false, 'limit' => <integer>, 'nextToken' => '<string>', 'resourceIds' => ['<string>', ...], 'resourceName' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', // REQUIRED ]);
Parameter Details
Members
- includeDeletedResources
-
- Type: boolean
Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.
- limit
-
- Type: int
The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- nextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - resourceIds
-
- Type: Array of strings
The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered. You can list a minimum of 1 resourceID and a maximum of 20 resourceIds.
- resourceName
-
- Type: string
The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.
- resourceType
-
- Required: Yes
- Type: string
The type of resources that you want Config to list in the response.
Result Syntax
[ 'nextToken' => '<string>', 'resourceIdentifiers' => [ [ 'resourceDeletionTime' => <DateTime>, 'resourceId' => '<string>', 'resourceName' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The string that you use in a subsequent request to get the next page of results in a paginated response.
- resourceIdentifiers
-
- Type: Array of ResourceIdentifier structures
The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- NoAvailableConfigurationRecorderException:
There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
ListResourceEvaluations
$result = $client->listResourceEvaluations
([/* ... */]); $promise = $client->listResourceEvaluationsAsync
([/* ... */]);
Returns a list of proactive resource evaluations.
Parameter Syntax
$result = $client->listResourceEvaluations([ 'Filters' => [ 'EvaluationContextIdentifier' => '<string>', 'EvaluationMode' => 'DETECTIVE|PROACTIVE', 'TimeWindow' => [ 'EndTime' => <integer || string || DateTime>, 'StartTime' => <integer || string || DateTime>, ], ], 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: ResourceEvaluationFilters structure
Returns a
ResourceEvaluationFilters
object. - Limit
-
- Type: int
The maximum number of evaluations returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response.
Result Syntax
[ 'NextToken' => '<string>', 'ResourceEvaluations' => [ [ 'EvaluationMode' => 'DETECTIVE|PROACTIVE', 'EvaluationStartTimestamp' => <DateTime>, 'ResourceEvaluationId' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - ResourceEvaluations
-
- Type: Array of ResourceEvaluation structures
Returns a
ResourceEvaluations
object.
Errors
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidTimeRangeException:
The specified time range is not valid. The earlier time is not chronologically before the later time.
ListStoredQueries
$result = $client->listStoredQueries
([/* ... */]); $promise = $client->listStoredQueriesAsync
([/* ... */]);
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
Parameter Syntax
$result = $client->listStoredQueries([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to be returned with a single call.
- NextToken
-
- Type: string
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Result Syntax
[ 'NextToken' => '<string>', 'StoredQueryMetadata' => [ [ 'Description' => '<string>', 'QueryArn' => '<string>', 'QueryId' => '<string>', 'QueryName' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
If the previous paginated request didn't return all of the remaining results, the response object's
NextToken
parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
. - StoredQueryMetadata
-
- Type: Array of StoredQueryMetadata structures
A list of
StoredQueryMetadata
objects.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
List the tags for Config resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'Limit' => <integer>, 'NextToken' => '<string>', 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, Config uses the default.
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are
ConfigRule
,ConfigurationAggregator
andAggregatorAuthorization
.
Result Syntax
[ 'NextToken' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned on a previous page that you use to get the next page of results in a paginated response. - Tags
-
- Type: Array of Tag structures
The tags for the resource.
Errors
- ResourceNotFoundException:
You have specified a resource that does not exist.
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
PutAggregationAuthorization
$result = $client->putAggregationAuthorization
([/* ... */]); $promise = $client->putAggregationAuthorizationAsync
([/* ... */]);
Authorizes the aggregator account and region to collect data from the source account and region.
PutAggregationAuthorization
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags
will not be updated, even if they are different.
Parameter Syntax
$result = $client->putAggregationAuthorization([ 'AuthorizedAccountId' => '<string>', // REQUIRED 'AuthorizedAwsRegion' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- AuthorizedAccountId
-
- Required: Yes
- Type: string
The 12-digit account ID of the account authorized to aggregate data.
- AuthorizedAwsRegion
-
- Required: Yes
- Type: string
The region authorized to collect aggregated data.
- Tags
-
- Type: Array of Tag structures
An array of tag object.
Result Syntax
[ 'AggregationAuthorization' => [ 'AggregationAuthorizationArn' => '<string>', 'AuthorizedAccountId' => '<string>', 'AuthorizedAwsRegion' => '<string>', 'CreationTime' => <DateTime>, ], ]
Result Details
Members
- AggregationAuthorization
-
- Type: AggregationAuthorization structure
Returns an AggregationAuthorization object.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
PutConfigRule
$result = $client->putConfigRule
([/* ... */]); $promise = $client->putConfigRuleAsync
([/* ... */]);
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
There are two types of rules: Config Managed Rules and Config Custom Rules. You can use PutConfigRule
to create both Config Managed Rules and Config Custom Rules.
Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the SourceIdentifier
key.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function that the rule invokes to evaluate your resources. When you use PutConfigRule
to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN in the SourceIdentifier
key. This key is part of the Source
object, which is part of the ConfigRule
object.
For any new Config rule that you add, specify the ConfigRuleName
in the ConfigRule
object. Do not specify the ConfigRuleArn
or the ConfigRuleId
. These values are generated by Config for new rules.
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName
, ConfigRuleId
, or ConfigRuleArn
in the ConfigRule
data type that you use in this request.
For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide.
PutConfigRule
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags
will not be updated, even if they are different.
Parameter Syntax
$result = $client->putConfigRule([ 'ConfigRule' => [ // REQUIRED 'ConfigRuleArn' => '<string>', 'ConfigRuleId' => '<string>', 'ConfigRuleName' => '<string>', 'ConfigRuleState' => 'ACTIVE|DELETING|DELETING_RESULTS|EVALUATING', 'CreatedBy' => '<string>', 'Description' => '<string>', 'EvaluationModes' => [ [ 'Mode' => 'DETECTIVE|PROACTIVE', ], // ... ], 'InputParameters' => '<string>', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'Scope' => [ 'ComplianceResourceId' => '<string>', 'ComplianceResourceTypes' => ['<string>', ...], 'TagKey' => '<string>', 'TagValue' => '<string>', ], 'Source' => [ // REQUIRED 'CustomPolicyDetails' => [ 'EnableDebugLogDelivery' => true || false, 'PolicyRuntime' => '<string>', // REQUIRED 'PolicyText' => '<string>', // REQUIRED ], 'Owner' => 'CUSTOM_LAMBDA|AWS|CUSTOM_POLICY', // REQUIRED 'SourceDetails' => [ [ 'EventSource' => 'aws.config', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'MessageType' => 'ConfigurationItemChangeNotification|ConfigurationSnapshotDeliveryCompleted|ScheduledNotification|OversizedConfigurationItemChangeNotification', ], // ... ], 'SourceIdentifier' => '<string>', ], ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- ConfigRule
-
- Required: Yes
- Type: ConfigRule structure
The rule that you want to add to your account.
- Tags
-
- Type: Array of Tag structures
An array of tag object.
Result Syntax
[]
Result Details
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- MaxNumberOfConfigRulesExceededException:
Failed to add the Config rule because the account already contains the maximum number of 1000 rules. Consider deleting any deactivated rules before you add new rules.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoAvailableConfigurationRecorderException:
There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
PutConfigurationAggregator
$result = $client->putConfigurationAggregator
([/* ... */]); $promise = $client->putConfigurationAggregatorAsync
([/* ... */]);
Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
accountIds
that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators
to get the previous accounts and then append new ones.
Config should be enabled in source accounts and regions you want to aggregate.
If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess
API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators
API to verify whether the caller is a valid delegated administrator.
To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.
PutConfigurationAggregator
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags
will not be updated, even if they are different.
Parameter Syntax
$result = $client->putConfigurationAggregator([ 'AccountAggregationSources' => [ [ 'AccountIds' => ['<string>', ...], // REQUIRED 'AllAwsRegions' => true || false, 'AwsRegions' => ['<string>', ...], ], // ... ], 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'OrganizationAggregationSource' => [ 'AllAwsRegions' => true || false, 'AwsRegions' => ['<string>', ...], 'RoleArn' => '<string>', // REQUIRED ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- AccountAggregationSources
-
- Type: Array of AccountAggregationSource structures
A list of AccountAggregationSource object.
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- OrganizationAggregationSource
-
- Type: OrganizationAggregationSource structure
An OrganizationAggregationSource object.
- Tags
-
- Type: Array of Tag structures
An array of tag object.
Result Syntax
[ 'ConfigurationAggregator' => [ 'AccountAggregationSources' => [ [ 'AccountIds' => ['<string>', ...], 'AllAwsRegions' => true || false, 'AwsRegions' => ['<string>', ...], ], // ... ], 'ConfigurationAggregatorArn' => '<string>', 'ConfigurationAggregatorName' => '<string>', 'CreatedBy' => '<string>', 'CreationTime' => <DateTime>, 'LastUpdatedTime' => <DateTime>, 'OrganizationAggregationSource' => [ 'AllAwsRegions' => true || false, 'AwsRegions' => ['<string>', ...], 'RoleArn' => '<string>', ], ], ]
Result Details
Members
- ConfigurationAggregator
-
- Type: ConfigurationAggregator structure
Returns a ConfigurationAggregator object.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- LimitExceededException:
For
StartConfigRulesEvaluation
API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.For
PutConfigurationAggregator
API, this exception is thrown if the number of accounts and aggregators exceeds the limit.- InvalidRoleException:
You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.
- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
- NoAvailableOrganizationException:
Organization is no longer available.
- OrganizationAllFeaturesNotEnabledException:
Config resource cannot be created because your organization does not have all features enabled.
PutConfigurationRecorder
$result = $client->putConfigurationRecorder
([/* ... */]); $promise = $client->putConfigurationRecorderAsync
([/* ... */]);
Creates a new configuration recorder to record configuration changes for specified resource types.
You can also use this action to change the roleARN
or the recordingGroup
of an existing recorder. For more information, see Managing the Configuration Recorder in the Config Developer Guide.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
If the configuration recorder does not have the recordingGroup
field specified, the default is to record all supported resource types.
Parameter Syntax
$result = $client->putConfigurationRecorder([ 'ConfigurationRecorder' => [ // REQUIRED 'name' => '<string>', 'recordingGroup' => [ 'allSupported' => true || false, 'exclusionByResourceTypes' => [ 'resourceTypes' => ['<string>', ...], ], 'includeGlobalResourceTypes' => true || false, 'recordingStrategy' => [ 'useOnly' => 'ALL_SUPPORTED_RESOURCE_TYPES|INCLUSION_BY_RESOURCE_TYPES|EXCLUSION_BY_RESOURCE_TYPES', ], 'resourceTypes' => ['<string>', ...], ], 'recordingMode' => [ 'recordingFrequency' => 'CONTINUOUS|DAILY', // REQUIRED 'recordingModeOverrides' => [ [ 'description' => '<string>', 'recordingFrequency' => 'CONTINUOUS|DAILY', // REQUIRED 'resourceTypes' => ['<string>', ...], // REQUIRED ], // ... ], ], 'roleARN' => '<string>', ], ]);
Parameter Details
Members
- ConfigurationRecorder
-
- Required: Yes
- Type: ConfigurationRecorder structure
An object for the configuration recorder to record configuration changes for specified resource types.
Result Syntax
[]
Result Details
Errors
- MaxNumberOfConfigurationRecordersExceededException:
You have reached the limit of the number of configuration recorders you can create.
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidConfigurationRecorderNameException:
You have provided a name for the configuration recorder that is not valid.
- InvalidRoleException:
You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.
- InvalidRecordingGroupException:
Indicates one of the following errors:
-
You have provided a combination of parameter values that is not valid. For example:
-
Setting the
allSupported
field of RecordingGroup totrue
, but providing a non-empty list for theresourceTypes
field of RecordingGroup. -
Setting the
allSupported
field of RecordingGroup totrue
, but also setting theuseOnly
field of RecordingStrategy toEXCLUSION_BY_RESOURCE_TYPES
.
-
-
Every parameter is either null, false, or empty.
-
You have reached the limit of the number of resource types you can provide for the recording group.
-
You have provided resource types or a recording strategy that are not valid.
-
PutConformancePack
$result = $client->putConformancePack
([/* ... */]); $promise = $client->putConformancePackAsync
([/* ... */]);
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
This API creates a service-linked role AWSServiceRoleForConfigConforms
in your account. The service-linked role is created only when the role does not exist in your account.
You must specify only one of the follow parameters: TemplateS3Uri
, TemplateBody
or TemplateSSMDocumentDetails
.
Parameter Syntax
$result = $client->putConformancePack([ 'ConformancePackInputParameters' => [ [ 'ParameterName' => '<string>', // REQUIRED 'ParameterValue' => '<string>', // REQUIRED ], // ... ], 'ConformancePackName' => '<string>', // REQUIRED 'DeliveryS3Bucket' => '<string>', 'DeliveryS3KeyPrefix' => '<string>', 'TemplateBody' => '<string>', 'TemplateS3Uri' => '<string>', 'TemplateSSMDocumentDetails' => [ 'DocumentName' => '<string>', // REQUIRED 'DocumentVersion' => '<string>', ], ]);
Parameter Details
Members
- ConformancePackInputParameters
-
- Type: Array of ConformancePackInputParameter structures
A list of
ConformancePackInputParameter
objects. - ConformancePackName
-
- Required: Yes
- Type: string
The unique name of the conformance pack you want to deploy.
- DeliveryS3Bucket
-
- Type: string
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional.
- DeliveryS3KeyPrefix
-
- Type: string
The prefix for the Amazon S3 bucket.
This field is optional.
- TemplateBody
-
- Type: string
A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.
You can use a YAML template with two resource types: Config rule (
AWS::Config::ConfigRule
) and remediation action (AWS::Config::RemediationConfiguration
). - TemplateS3Uri
-
- Type: string
The location of the file containing the template body (
s3://bucketname/prefix
). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.
- TemplateSSMDocumentDetails
-
- Type: TemplateSSMDocumentDetails structure
An object of type
TemplateSSMDocumentDetails
, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.
Result Syntax
[ 'ConformancePackArn' => '<string>', ]
Result Details
Members
- ConformancePackArn
-
- Type: string
ARN of the conformance pack.
Errors
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- ConformancePackTemplateValidationException:
You have specified a template that is not valid or supported.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- MaxNumberOfConformancePacksExceededException:
You have reached the limit of the number of conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.
PutDeliveryChannel
$result = $client->putDeliveryChannel
([/* ... */]); $promise = $client->putDeliveryChannelAsync
([/* ... */]);
Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic. For more information, see Notifications that Config Sends to an Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
You can have only one delivery channel per region in your account.
Parameter Syntax
$result = $client->putDeliveryChannel([ 'DeliveryChannel' => [ // REQUIRED 'configSnapshotDeliveryProperties' => [ 'deliveryFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', ], 'name' => '<string>', 's3BucketName' => '<string>', 's3KeyPrefix' => '<string>', 's3KmsKeyArn' => '<string>', 'snsTopicARN' => '<string>', ], ]);
Parameter Details
Members
- DeliveryChannel
-
- Required: Yes
- Type: DeliveryChannel structure
The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.
Result Syntax
[]
Result Details
Errors
- MaxNumberOfDeliveryChannelsExceededException:
You have reached the limit of the number of delivery channels you can create.
- NoAvailableConfigurationRecorderException:
There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- InvalidDeliveryChannelNameException:
The specified delivery channel name is not valid.
- NoSuchBucketException:
The specified Amazon S3 bucket does not exist.
- InvalidS3KeyPrefixException:
The specified Amazon S3 key prefix is not valid.
- InvalidS3KmsKeyArnException:
The specified Amazon KMS Key ARN is not valid.
- InvalidSNSTopicARNException:
The specified Amazon SNS topic does not exist.
- InsufficientDeliveryPolicyException:
Your Amazon S3 bucket policy does not permit Config to write to it.
PutEvaluations
$result = $client->putEvaluations
([/* ... */]); $promise = $client->putEvaluationsAsync
([/* ... */]);
Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.
Parameter Syntax
$result = $client->putEvaluations([ 'Evaluations' => [ [ 'Annotation' => '<string>', 'ComplianceResourceId' => '<string>', // REQUIRED 'ComplianceResourceType' => '<string>', // REQUIRED 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', // REQUIRED 'OrderingTimestamp' => <integer || string || DateTime>, // REQUIRED ], // ... ], 'ResultToken' => '<string>', // REQUIRED 'TestMode' => true || false, ]);
Parameter Details
Members
- Evaluations
-
- Type: Array of Evaluation structures
The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.
- ResultToken
-
- Required: Yes
- Type: string
An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.
- TestMode
-
- Type: boolean
Use this parameter to specify a test run for
PutEvaluations
. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.When
TestMode
istrue
,PutEvaluations
doesn't require a valid value for theResultToken
parameter, but the value cannot be null.
Result Syntax
[ 'FailedEvaluations' => [ [ 'Annotation' => '<string>', 'ComplianceResourceId' => '<string>', 'ComplianceResourceType' => '<string>', 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', 'OrderingTimestamp' => <DateTime>, ], // ... ], ]
Result Details
Members
- FailedEvaluations
-
- Type: Array of Evaluation structures
Requests that failed because of a client or server error.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidResultTokenException:
The specified
ResultToken
is not valid.- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
PutExternalEvaluation
$result = $client->putExternalEvaluation
([/* ... */]); $promise = $client->putExternalEvaluationAsync
([/* ... */]);
Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.
Parameter Syntax
$result = $client->putExternalEvaluation([ 'ConfigRuleName' => '<string>', // REQUIRED 'ExternalEvaluation' => [ // REQUIRED 'Annotation' => '<string>', 'ComplianceResourceId' => '<string>', // REQUIRED 'ComplianceResourceType' => '<string>', // REQUIRED 'ComplianceType' => 'COMPLIANT|NON_COMPLIANT|NOT_APPLICABLE|INSUFFICIENT_DATA', // REQUIRED 'OrderingTimestamp' => <integer || string || DateTime>, // REQUIRED ], ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule.
- ExternalEvaluation
-
- Required: Yes
- Type: ExternalEvaluation structure
An
ExternalEvaluation
object that provides details about compliance.
Result Syntax
[]
Result Details
Errors
- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
PutOrganizationConfigRule
$result = $client->putOrganizationConfigRule
([/* ... */]); $promise = $client->putOrganizationConfigRuleAsync
([/* ... */]);
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access through the EnableAWSServiceAccess
action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with GetRole
action.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator
for config-multiaccountsetup.amazonaws.com
.
There are two types of rules: Config Managed Rules and Config Custom Rules. You can use PutOrganizationConfigRule
to create both Config Managed Rules and Config Custom Rules.
Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the RuleIdentifier
key.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use PutOrganizationConfigRule
to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
Make sure to specify one of either OrganizationCustomPolicyRuleMetadata
for Custom Policy rules, OrganizationCustomRuleMetadata
for Custom Lambda rules, or OrganizationManagedRuleMetadata
for managed rules.
Parameter Syntax
$result = $client->putOrganizationConfigRule([ 'ExcludedAccounts' => ['<string>', ...], 'OrganizationConfigRuleName' => '<string>', // REQUIRED 'OrganizationCustomPolicyRuleMetadata' => [ 'DebugLogDeliveryAccounts' => ['<string>', ...], 'Description' => '<string>', 'InputParameters' => '<string>', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'OrganizationConfigRuleTriggerTypes' => ['<string>', ...], 'PolicyRuntime' => '<string>', // REQUIRED 'PolicyText' => '<string>', // REQUIRED 'ResourceIdScope' => '<string>', 'ResourceTypesScope' => ['<string>', ...], 'TagKeyScope' => '<string>', 'TagValueScope' => '<string>', ], 'OrganizationCustomRuleMetadata' => [ 'Description' => '<string>', 'InputParameters' => '<string>', 'LambdaFunctionArn' => '<string>', // REQUIRED 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'OrganizationConfigRuleTriggerTypes' => ['<string>', ...], // REQUIRED 'ResourceIdScope' => '<string>', 'ResourceTypesScope' => ['<string>', ...], 'TagKeyScope' => '<string>', 'TagValueScope' => '<string>', ], 'OrganizationManagedRuleMetadata' => [ 'Description' => '<string>', 'InputParameters' => '<string>', 'MaximumExecutionFrequency' => 'One_Hour|Three_Hours|Six_Hours|Twelve_Hours|TwentyFour_Hours', 'ResourceIdScope' => '<string>', 'ResourceTypesScope' => ['<string>', ...], 'RuleIdentifier' => '<string>', // REQUIRED 'TagKeyScope' => '<string>', 'TagValueScope' => '<string>', ], ]);
Parameter Details
Members
- ExcludedAccounts
-
- Type: Array of strings
A comma-separated list of accounts that you want to exclude from an organization Config rule.
- OrganizationConfigRuleName
-
- Required: Yes
- Type: string
The name that you assign to an organization Config rule.
- OrganizationCustomPolicyRuleMetadata
-
- Type: OrganizationCustomPolicyRuleMetadata structure
An
OrganizationCustomPolicyRuleMetadata
object. This object specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule. - OrganizationCustomRuleMetadata
-
- Type: OrganizationCustomRuleMetadata structure
An
OrganizationCustomRuleMetadata
object. This object specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. - OrganizationManagedRuleMetadata
-
- Type: OrganizationManagedRuleMetadata structure
An
OrganizationManagedRuleMetadata
object. This object specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
Result Syntax
[ 'OrganizationConfigRuleArn' => '<string>', ]
Result Details
Members
- OrganizationConfigRuleArn
-
- Type: string
The Amazon Resource Name (ARN) of an organization Config rule.
Errors
- MaxNumberOfOrganizationConfigRulesExceededException:
You have reached the limit of the number of organization Config rules you can create. For more information, see see Service Limits in the Config Developer Guide.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
- NoAvailableOrganizationException:
Organization is no longer available.
- OrganizationAllFeaturesNotEnabledException:
Config resource cannot be created because your organization does not have all features enabled.
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
PutOrganizationConformancePack
$result = $client->putOrganizationConformancePack
([/* ... */]); $promise = $client->putOrganizationConformancePackAsync
([/* ... */]);
Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access for config-multiaccountsetup.amazonaws.com
through the EnableAWSServiceAccess
action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin
for config-multiaccountsetup.amazonaws.com
.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
Parameter Syntax
$result = $client->putOrganizationConformancePack([ 'ConformancePackInputParameters' => [ [ 'ParameterName' => '<string>', // REQUIRED 'ParameterValue' => '<string>', // REQUIRED ], // ... ], 'DeliveryS3Bucket' => '<string>', 'DeliveryS3KeyPrefix' => '<string>', 'ExcludedAccounts' => ['<string>', ...], 'OrganizationConformancePackName' => '<string>', // REQUIRED 'TemplateBody' => '<string>', 'TemplateS3Uri' => '<string>', ]);
Parameter Details
Members
- ConformancePackInputParameters
-
- Type: Array of ConformancePackInputParameter structures
A list of
ConformancePackInputParameter
objects. - DeliveryS3Bucket
-
- Type: string
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional. If used, it must be prefixed with
awsconfigconforms
. - DeliveryS3KeyPrefix
-
- Type: string
The prefix for the Amazon S3 bucket.
This field is optional.
- ExcludedAccounts
-
- Type: Array of strings
A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.
- OrganizationConformancePackName
-
- Required: Yes
- Type: string
Name of the organization conformance pack you want to create.
- TemplateBody
-
- Type: string
A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
- TemplateS3Uri
-
- Type: string
Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).
You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.
Result Syntax
[ 'OrganizationConformancePackArn' => '<string>', ]
Result Details
Members
- OrganizationConformancePackArn
-
- Type: string
ARN of the organization conformance pack.
Errors
- MaxNumberOfOrganizationConformancePacksExceededException:
You have reached the limit of the number of organization conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.
- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- OrganizationAccessDeniedException:
For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.-
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- OrganizationConformancePackTemplateValidationException:
You have specified a template that is not valid or supported.
- OrganizationAllFeaturesNotEnabledException:
Config resource cannot be created because your organization does not have all features enabled.
- NoAvailableOrganizationException:
Organization is no longer available.
PutRemediationConfigurations
$result = $client->putRemediationConfigurations
([/* ... */]); $promise = $client->putRemediationConfigurationsAsync
([/* ... */]);
Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration
object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.
Be aware of backward incompatible changes
If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.
This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
Required fields
For manual remediation configuration, you need to provide a value for automationAssumeRole
or use a value in the assumeRole
field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.
However, for automatic remediation configuration, the only valid assumeRole
field value is AutomationAssumeRole
and you need to provide a value for AutomationAssumeRole
to remediate your resources.
Auto remediation can be initiated even for compliant resources
If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
Parameter Syntax
$result = $client->putRemediationConfigurations([ 'RemediationConfigurations' => [ // REQUIRED [ 'Arn' => '<string>', 'Automatic' => true || false, 'ConfigRuleName' => '<string>', // REQUIRED 'CreatedByService' => '<string>', 'ExecutionControls' => [ 'SsmControls' => [ 'ConcurrentExecutionRatePercentage' => <integer>, 'ErrorPercentage' => <integer>, ], ], 'MaximumAutomaticAttempts' => <integer>, 'Parameters' => [ '<StringWithCharLimit256>' => [ 'ResourceValue' => [ 'Value' => 'RESOURCE_ID', // REQUIRED ], 'StaticValue' => [ 'Values' => ['<string>', ...], // REQUIRED ], ], // ... ], 'ResourceType' => '<string>', 'RetryAttemptSeconds' => <integer>, 'TargetId' => '<string>', // REQUIRED 'TargetType' => 'SSM_DOCUMENT', // REQUIRED 'TargetVersion' => '<string>', ], // ... ], ]);
Parameter Details
Members
- RemediationConfigurations
-
- Required: Yes
- Type: Array of RemediationConfiguration structures
A list of remediation configuration objects.
Result Syntax
[ 'FailedBatches' => [ [ 'FailedItems' => [ [ 'Arn' => '<string>', 'Automatic' => true || false, 'ConfigRuleName' => '<string>', 'CreatedByService' => '<string>', 'ExecutionControls' => [ 'SsmControls' => [ 'ConcurrentExecutionRatePercentage' => <integer>, 'ErrorPercentage' => <integer>, ], ], 'MaximumAutomaticAttempts' => <integer>, 'Parameters' => [ '<StringWithCharLimit256>' => [ 'ResourceValue' => [ 'Value' => 'RESOURCE_ID', ], 'StaticValue' => [ 'Values' => ['<string>', ...], ], ], // ... ], 'ResourceType' => '<string>', 'RetryAttemptSeconds' => <integer>, 'TargetId' => '<string>', 'TargetType' => 'SSM_DOCUMENT', 'TargetVersion' => '<string>', ], // ... ], 'FailureMessage' => '<string>', ], // ... ], ]
Result Details
Members
- FailedBatches
-
- Type: Array of FailedRemediationBatch structures
Returns a list of failed remediation batch objects.
Errors
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
PutRemediationExceptions
$result = $client->putRemediationExceptions
([/* ... */]); $promise = $client->putRemediationExceptionsAsync
([/* ... */]);
A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
Exceptions block auto remediation
Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
Manual remediation is recommended when placing an exception
When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as NON_COMPLIANT
. Once the resource has been evaluated as NON_COMPLIANT
, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT
evaluation result can delete resources before the exception is applied.
Exceptions can only be performed on non-compliant resources
Placing an exception can only be performed on resources that are NON_COMPLIANT
. If you use this API for COMPLIANT
resources or resources that are NOT_APPLICABLE
, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules in the Config Developer Guide.
Auto remediation can be initiated even for compliant resources
If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
Parameter Syntax
$result = $client->putRemediationExceptions([ 'ConfigRuleName' => '<string>', // REQUIRED 'ExpirationTime' => <integer || string || DateTime>, 'Message' => '<string>', 'ResourceKeys' => [ // REQUIRED [ 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], // ... ], ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
The name of the Config rule for which you want to create remediation exception.
- ExpirationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The exception is automatically deleted after the expiration date.
- Message
-
- Type: string
The message contains an explanation of the exception.
- ResourceKeys
-
- Required: Yes
- Type: Array of RemediationExceptionResourceKey structures
An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
Result Syntax
[ 'FailedBatches' => [ [ 'FailedItems' => [ [ 'ConfigRuleName' => '<string>', 'ExpirationTime' => <DateTime>, 'Message' => '<string>', 'ResourceId' => '<string>', 'ResourceType' => '<string>', ], // ... ], 'FailureMessage' => '<string>', ], // ... ], ]
Result Details
Members
- FailedBatches
-
- Type: Array of FailedRemediationExceptionBatch structures
Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
PutResourceConfig
$result = $client->putResourceConfig
([/* ... */]); $promise = $client->putResourceConfigAsync
([/* ... */]);
Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.
The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.
When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
Write-only schema properites are not recorded as part of the published configuration item.
Parameter Syntax
$result = $client->putResourceConfig([ 'Configuration' => '<string>', // REQUIRED 'ResourceId' => '<string>', // REQUIRED 'ResourceName' => '<string>', 'ResourceType' => '<string>', // REQUIRED 'SchemaVersionId' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- Configuration
-
- Required: Yes
- Type: string
The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.
The configuration JSON must not exceed 64 KB.
- ResourceId
-
- Required: Yes
- Type: string
Unique identifier of the resource.
- ResourceName
-
- Type: string
Name of the resource.
- ResourceType
-
- Required: Yes
- Type: string
The type of the resource. The custom resource type must be registered with CloudFormation.
You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.
- SchemaVersionId
-
- Required: Yes
- Type: string
Version of the schema registered for the ResourceType in CloudFormation.
- Tags
-
- Type: Associative array of custom strings keys (Name) to strings
Tags associated with the resource.
This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for
PutResourceConfig
are tags that you supply for the configuration items of your custom resources.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoRunningConfigurationRecorderException:
There is no configuration recorder running.
- MaxActiveResourcesExceededException:
You have reached the limit of active custom resource types in your account. There is a limit of 100,000. Delete unused resources using DeleteResourceConfig
.
PutRetentionConfiguration
$result = $client->putRetentionConfiguration
([/* ... */]); $promise = $client->putRetentionConfigurationAsync
([/* ... */]);
Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration
object and names the object as default. When you have a RetentionConfiguration
object named default, calling the API modifies the default object.
Currently, Config supports only one retention configuration per region in your account.
Parameter Syntax
$result = $client->putRetentionConfiguration([ 'RetentionPeriodInDays' => <integer>, // REQUIRED ]);
Parameter Details
Members
- RetentionPeriodInDays
-
- Required: Yes
- Type: int
Number of days Config stores your historical information.
Currently, only applicable to the configuration item history.
Result Syntax
[ 'RetentionConfiguration' => [ 'Name' => '<string>', 'RetentionPeriodInDays' => <integer>, ], ]
Result Details
Members
- RetentionConfiguration
-
- Type: RetentionConfiguration structure
Returns a retention configuration object.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- MaxNumberOfRetentionConfigurationsExceededException:
Failed to add the retention configuration because a retention configuration with that name already exists.
PutStoredQuery
$result = $client->putStoredQuery
([/* ... */]); $promise = $client->putStoredQueryAsync
([/* ... */]);
Saves a new query or updates an existing saved query. The QueryName
must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.
PutStoredQuery
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags
will not be updated, even if they are different.
Parameter Syntax
$result = $client->putStoredQuery([ 'StoredQuery' => [ // REQUIRED 'Description' => '<string>', 'Expression' => '<string>', 'QueryArn' => '<string>', 'QueryId' => '<string>', 'QueryName' => '<string>', // REQUIRED ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- StoredQuery
-
- Required: Yes
- Type: StoredQuery structure
A list of
StoredQuery
objects. The mandatory fields areQueryName
andExpression
.When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.
- Tags
-
- Type: Array of Tag structures
A list of
Tags
object.
Result Syntax
[ 'QueryArn' => '<string>', ]
Result Details
Members
- QueryArn
-
- Type: string
Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- TooManyTagsException:
You have reached the limit of the number of tags you can use. For more information, see Service Limits in the Config Developer Guide.
- ResourceConcurrentModificationException:
Two users are trying to modify the same query at the same time. Wait for a moment and try again.
SelectAggregateResourceConfig
$result = $client->selectAggregateResourceConfig
([/* ... */]); $promise = $client->selectAggregateResourceConfigAsync
([/* ... */]);
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
If you run an aggregation query (i.e., using GROUP BY
or using aggregate functions such as COUNT
; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId
) and do not specify the MaxResults
or the Limit
query parameters, the default page size is set to 500.
If you run a non-aggregation query (i.e., not using GROUP BY
or aggregate function; e.g., SELECT * WHERE resourceType = 'AWS::IAM::Role'
) and do not specify the MaxResults
or the Limit
query parameters, the default page size is set to 25.
Parameter Syntax
$result = $client->selectAggregateResourceConfig([ 'ConfigurationAggregatorName' => '<string>', // REQUIRED 'Expression' => '<string>', // REQUIRED 'Limit' => <integer>, 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ConfigurationAggregatorName
-
- Required: Yes
- Type: string
The name of the configuration aggregator.
- Expression
-
- Required: Yes
- Type: string
The SQL query SELECT command.
- Limit
-
- Type: int
The maximum number of query results returned on each page.
- MaxResults
-
- Type: int
The maximum number of query results returned on each page. Config also allows the Limit request parameter.
- NextToken
-
- Type: string
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Result Syntax
[ 'NextToken' => '<string>', 'QueryInfo' => [ 'SelectFields' => [ [ 'Name' => '<string>', ], // ... ], ], 'Results' => ['<string>', ...], ]
Result Details
Members
- NextToken
-
- Type: string
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
- QueryInfo
-
- Type: QueryInfo structure
Details about the query.
- Results
-
- Type: Array of strings
Returns the results for the SQL query.
Errors
- InvalidExpressionException:
The syntax of the query is incorrect.
- NoSuchConfigurationAggregatorException:
You have specified a configuration aggregator that does not exist.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
SelectResourceConfig
$result = $client->selectResourceConfig
([/* ... */]); $promise = $client->selectResourceConfigAsync
([/* ... */]);
Accepts a structured query language (SQL) SELECT
command, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
Parameter Syntax
$result = $client->selectResourceConfig([ 'Expression' => '<string>', // REQUIRED 'Limit' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- Expression
-
- Required: Yes
- Type: string
The SQL query
SELECT
command. - Limit
-
- Type: int
The maximum number of query results returned on each page.
- NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.
Result Syntax
[ 'NextToken' => '<string>', 'QueryInfo' => [ 'SelectFields' => [ [ 'Name' => '<string>', ], // ... ], ], 'Results' => ['<string>', ...], ]
Result Details
Members
- NextToken
-
- Type: string
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response. - QueryInfo
-
- Type: QueryInfo structure
Returns the
QueryInfo
object. - Results
-
- Type: Array of strings
Returns the results for the SQL query.
Errors
- InvalidExpressionException:
The syntax of the query is incorrect.
- InvalidLimitException:
The specified limit is outside the allowable range.
- InvalidNextTokenException:
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.
StartConfigRulesEvaluation
$result = $client->startConfigRulesEvaluation
([/* ... */]); $promise = $client->startConfigRulesEvaluationAsync
([/* ... */]);
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation
when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation
does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.
You can specify up to 25 Config rules per request.
An existing StartConfigRulesEvaluation
call for the specified rules must complete before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted
notification when the evaluation starts.
You don't need to call the StartConfigRulesEvaluation
API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.
The StartConfigRulesEvaluation
API is useful if you want to run on-demand evaluations, such as the following example:
-
You have a custom rule that evaluates your IAM resources every 24 hours.
-
You update your Lambda function to add additional conditions to your rule.
-
Instead of waiting for the next periodic evaluation, you call the
StartConfigRulesEvaluation
API. -
Config invokes your Lambda function and evaluates your IAM resources.
-
Your custom rule will still run periodic evaluations every 24 hours.
Parameter Syntax
$result = $client->startConfigRulesEvaluation([ 'ConfigRuleNames' => ['<string>', ...], ]);
Parameter Details
Members
- ConfigRuleNames
-
- Type: Array of strings
The list of names of Config rules that you want to run evaluations for.
Result Syntax
[]
Result Details
Errors
- NoSuchConfigRuleException:
The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- LimitExceededException:
For
StartConfigRulesEvaluation
API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.For
PutConfigurationAggregator
API, this exception is thrown if the number of accounts and aggregators exceeds the limit.- ResourceInUseException:
You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
StartConfigurationRecorder
$result = $client->startConfigurationRecorder
([/* ... */]); $promise = $client->startConfigurationRecorderAsync
([/* ... */]);
Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
You must have created at least one delivery channel to successfully start the configuration recorder.
Parameter Syntax
$result = $client->startConfigurationRecorder([ 'ConfigurationRecorderName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConfigurationRecorderName
-
- Required: Yes
- Type: string
The name of the recorder object that records each configuration change made to the resources.
Result Syntax
[]
Result Details
Errors
- NoSuchConfigurationRecorderException:
You have specified a configuration recorder that does not exist.
- NoAvailableDeliveryChannelException:
There is no delivery channel available to record configurations.
StartRemediationExecution
$result = $client->startRemediationExecution
([/* ... */]); $promise = $client->startRemediationExecutionAsync
([/* ... */]);
Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.
You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.
Parameter Syntax
$result = $client->startRemediationExecution([ 'ConfigRuleName' => '<string>', // REQUIRED 'ResourceKeys' => [ // REQUIRED [ 'resourceId' => '<string>', // REQUIRED 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ConfigRuleName
-
- Required: Yes
- Type: string
The list of names of Config rules that you want to run remediation execution for.
- ResourceKeys
-
- Required: Yes
- Type: Array of ResourceKey structures
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
Result Syntax
[ 'FailedItems' => [ [ 'resourceId' => '<string>', 'resourceType' => '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|AWS::ECS::TaskSet|AWS::Cassandra::Keyspace|AWS::Signer::SigningProfile|AWS::Amplify::App|AWS::AppMesh::VirtualNode|AWS::AppMesh::VirtualService|AWS::AppRunner::VpcConnector|AWS::AppStream::Application|AWS::CodeArtifact::Repository|AWS::EC2::PrefixList|AWS::EC2::SpotFleet|AWS::Evidently::Project|AWS::Forecast::Dataset|AWS::IAM::SAMLProvider|AWS::IAM::ServerCertificate|AWS::Pinpoint::Campaign|AWS::Pinpoint::InAppTemplate|AWS::SageMaker::Domain|AWS::Transfer::Agreement|AWS::Transfer::Connector|AWS::KinesisFirehose::DeliveryStream|AWS::Amplify::Branch|AWS::AppIntegrations::EventIntegration|AWS::AppMesh::Route|AWS::Athena::PreparedStatement|AWS::EC2::IPAMScope|AWS::Evidently::Launch|AWS::Forecast::DatasetGroup|AWS::GreengrassV2::ComponentVersion|AWS::GroundStation::MissionProfile|AWS::MediaConnect::FlowEntitlement|AWS::MediaConnect::FlowVpcInterface|AWS::MediaTailor::PlaybackConfiguration|AWS::MSK::Configuration|AWS::Personalize::Dataset|AWS::Personalize::Schema|AWS::Personalize::Solution|AWS::Pinpoint::EmailTemplate|AWS::Pinpoint::EventStream|AWS::ResilienceHub::App|AWS::ACMPCA::CertificateAuthority|AWS::AppConfig::HostedConfigurationVersion|AWS::AppMesh::VirtualGateway|AWS::AppMesh::VirtualRouter|AWS::AppRunner::Service|AWS::CustomerProfiles::ObjectType|AWS::DMS::Endpoint|AWS::EC2::CapacityReservation|AWS::EC2::ClientVpnEndpoint|AWS::Kendra::Index|AWS::KinesisVideo::Stream|AWS::Logs::Destination|AWS::Pinpoint::EmailChannel|AWS::S3::AccessPoint|AWS::NetworkManager::CustomerGatewayAssociation|AWS::NetworkManager::LinkAssociation|AWS::IoTWireless::MulticastGroup|AWS::Personalize::DatasetGroup|AWS::IoTTwinMaker::ComponentType|AWS::CodeBuild::ReportGroup|AWS::SageMaker::FeatureGroup|AWS::MSK::BatchScramSecret|AWS::AppStream::Stack|AWS::IoT::JobTemplate|AWS::IoTWireless::FuotaTask|AWS::IoT::ProvisioningTemplate|AWS::InspectorV2::Filter|AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation|AWS::ServiceDiscovery::Instance|AWS::Transfer::Certificate|AWS::MediaConnect::FlowSource|AWS::APS::RuleGroupsNamespace|AWS::CodeGuruProfiler::ProfilingGroup|AWS::Route53Resolver::ResolverQueryLoggingConfig|AWS::Batch::SchedulingPolicy|AWS::ACMPCA::CertificateAuthorityActivation|AWS::AppMesh::GatewayRoute|AWS::AppMesh::Mesh|AWS::Connect::Instance|AWS::Connect::QuickConnect|AWS::EC2::CarrierGateway|AWS::EC2::IPAMPool|AWS::EC2::TransitGatewayConnect|AWS::EC2::TransitGatewayMulticastDomain|AWS::ECS::CapacityProvider|AWS::IAM::InstanceProfile|AWS::IoT::CACertificate|AWS::IoTTwinMaker::SyncJob|AWS::KafkaConnect::Connector|AWS::Lambda::CodeSigningConfig|AWS::NetworkManager::ConnectPeer|AWS::ResourceExplorer2::Index|AWS::AppStream::Fleet|AWS::Cognito::UserPool|AWS::Cognito::UserPoolClient|AWS::Cognito::UserPoolGroup|AWS::EC2::NetworkInsightsAccessScope|AWS::EC2::NetworkInsightsAnalysis|AWS::Grafana::Workspace|AWS::GroundStation::DataflowEndpointGroup|AWS::ImageBuilder::ImageRecipe|AWS::KMS::Alias|AWS::M2::Environment|AWS::QuickSight::DataSource|AWS::QuickSight::Template|AWS::QuickSight::Theme|AWS::RDS::OptionGroup|AWS::Redshift::EndpointAccess|AWS::Route53Resolver::FirewallRuleGroup|AWS::SSM::Document', ], // ... ], 'FailureMessage' => '<string>', ]
Result Details
Members
- FailedItems
-
- Type: Array of ResourceKey structures
For resources that have failed to start execution, the API returns a resource key object.
- FailureMessage
-
- Type: string
Returns a failure message. For example, the resource is already compliant.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InsufficientPermissionsException:
Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoSuchRemediationConfigurationException:
You specified an Config rule without a remediation configuration.
StartResourceEvaluation
$result = $client->startResourceEvaluation
([/* ... */]); $promise = $client->startResourceEvaluationAsync
([/* ... */]);
Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.
Ensure you have the cloudformation:DescribeType
role setup to validate the resource type schema.
You can find the Resource type schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE
.
For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.
Parameter Syntax
$result = $client->startResourceEvaluation([ 'ClientToken' => '<string>', 'EvaluationContext' => [ 'EvaluationContextIdentifier' => '<string>', ], 'EvaluationMode' => 'DETECTIVE|PROACTIVE', // REQUIRED 'EvaluationTimeout' => <integer>, 'ResourceDetails' => [ // REQUIRED 'ResourceConfiguration' => '<string>', // REQUIRED 'ResourceConfigurationSchemaType' => 'CFN_RESOURCE_SCHEMA', 'ResourceId' => '<string>', // REQUIRED 'ResourceType' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.
Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.
- EvaluationContext
-
- Type: EvaluationContext structure
Returns an
EvaluationContext
object. - EvaluationMode
-
- Required: Yes
- Type: string
The mode of an evaluation. The valid values for this API are
DETECTIVE
andPROACTIVE
. - EvaluationTimeout
-
- Type: int
The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.
- ResourceDetails
-
- Required: Yes
- Type: ResourceDetails structure
Returns a
ResourceDetails
object.
Result Syntax
[ 'ResourceEvaluationId' => '<string>', ]
Result Details
Members
- ResourceEvaluationId
-
- Type: string
A unique ResourceEvaluationId that is associated with a single execution.
Errors
- InvalidParameterValueException:
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- IdempotentParameterMismatch:
Using the same client token with one or more different parameters. Specify a new client token with the parameter changes and try again.
StopConfigurationRecorder
$result = $client->stopConfigurationRecorder
([/* ... */]); $promise = $client->stopConfigurationRecorderAsync
([/* ... */]);
Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
Parameter Syntax
$result = $client->stopConfigurationRecorder([ 'ConfigurationRecorderName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConfigurationRecorderName
-
- Required: Yes
- Type: string
The name of the recorder object that records each configuration change made to the resources.
Result Syntax
[]
Result Details
Errors
- NoSuchConfigurationRecorderException:
You have specified a configuration recorder that does not exist.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are
ConfigRule
,ConfigurationAggregator
andAggregatorAuthorization
. - Tags
-
- Required: Yes
- Type: Array of Tag structures
An array of tag object.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException:
You have specified a resource that does not exist.
- TooManyTagsException:
You have reached the limit of the number of tags you can use. For more information, see Service Limits in the Config Developer Guide.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Deletes specified tags from a resource.
Parameter Syntax
$result = $client->untagResource([ 'ResourceArn' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are
ConfigRule
,ConfigurationAggregator
andAggregatorAuthorization
. - TagKeys
-
- Required: Yes
- Type: Array of strings
The keys of the tags to be removed.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException:
You have specified a resource that does not exist.
Shapes
AccountAggregationSource
Description
A collection of accounts and regions.
Members
- AccountIds
-
- Required: Yes
- Type: Array of strings
The 12-digit account ID of the account being aggregated.
- AllAwsRegions
-
- Type: boolean
If true, aggregate existing Config regions and future regions.
- AwsRegions
-
- Type: Array of strings
The source regions being aggregated.
AggregateComplianceByConfigRule
Description
Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.
A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.
Members
- AccountId
-
- Type: string
The 12-digit account ID of the source account.
- AwsRegion
-
- Type: string
The source region from where the data is aggregated.
- Compliance
-
- Type: Compliance structure
Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.
- ConfigRuleName
-
- Type: string
The name of the Config rule.
AggregateComplianceByConformancePack
Description
Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.
A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.
Members
- AccountId
-
- Type: string
The 12-digit Amazon Web Services account ID of the source account.
- AwsRegion
-
- Type: string
The source Amazon Web Services Region from where the data is aggregated.
- Compliance
-
- Type: AggregateConformancePackCompliance structure
The compliance status of the conformance pack.
- ConformancePackName
-
- Type: string
The name of the conformance pack.
AggregateComplianceCount
Description
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
Members
- ComplianceSummary
-
- Type: ComplianceSummary structure
The number of compliant and noncompliant Config rules.
- GroupName
-
- Type: string
The 12-digit account ID or region based on the GroupByKey value.
AggregateConformancePackCompliance
Description
Provides the number of compliant and noncompliant rules within a conformance pack. Also provides the compliance status of the conformance pack and the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.
Members
- ComplianceType
-
- Type: string
The compliance status of the conformance pack.
- CompliantRuleCount
-
- Type: int
The number of compliant Config Rules.
- NonCompliantRuleCount
-
- Type: int
The number of noncompliant Config Rules.
- TotalRuleCount
-
- Type: int
Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.
AggregateConformancePackComplianceCount
Description
The number of conformance packs that are compliant and noncompliant.
Members
- CompliantConformancePackCount
-
- Type: int
Number of compliant conformance packs.
- NonCompliantConformancePackCount
-
- Type: int
Number of noncompliant conformance packs.
AggregateConformancePackComplianceFilters
Description
Filters the conformance packs based on an account ID, region, compliance type, and the name of the conformance pack.
Members
- AccountId
-
- Type: string
The 12-digit Amazon Web Services account ID of the source account.
- AwsRegion
-
- Type: string
The source Amazon Web Services Region from where the data is aggregated.
- ComplianceType
-
- Type: string
The compliance status of the conformance pack.
- ConformancePackName
-
- Type: string
The name of the conformance pack.
AggregateConformancePackComplianceSummary
Description
Provides a summary of compliance based on either account ID or region.
Members
- ComplianceSummary
-
- Type: AggregateConformancePackComplianceCount structure
Returns an
AggregateConformancePackComplianceCount
object. - GroupName
-
- Type: string
Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
AggregateConformancePackComplianceSummaryFilters
Description
Filters the results based on account ID and region.
Members
- AccountId
-
- Type: string
The 12-digit Amazon Web Services account ID of the source account.
- AwsRegion
-
- Type: string
The source Amazon Web Services Region from where the data is aggregated.
AggregateEvaluationResult
Description
The details of an Config evaluation for an account ID and region in an aggregator. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
Members
- AccountId
-
- Type: string
The 12-digit account ID of the source account.
- Annotation
-
- Type: string
Supplementary information about how the agrregate evaluation determined the compliance.
- AwsRegion
-
- Type: string
The source region from where the data is aggregated.
- ComplianceType
-
- Type: string
The resource compliance status.
For the
AggregationEvaluationResult
data type, Config supports only theCOMPLIANT
andNON_COMPLIANT
. Config does not support theNOT_APPLICABLE
andINSUFFICIENT_DATA
value. - ConfigRuleInvokedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the Config rule evaluated the Amazon Web Services resource.
- EvaluationResultIdentifier
-
- Type: EvaluationResultIdentifier structure
Uniquely identifies the evaluation result.
- ResultRecordedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when Config recorded the aggregate evaluation result.
AggregateResourceIdentifier
Description
The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.
Members
- ResourceId
-
- Required: Yes
- Type: string
The ID of the Amazon Web Services resource.
- ResourceName
-
- Type: string
The name of the Amazon Web Services resource.
- ResourceType
-
- Required: Yes
- Type: string
The type of the Amazon Web Services resource.
- SourceAccountId
-
- Required: Yes
- Type: string
The 12-digit account ID of the source account.
- SourceRegion
-
- Required: Yes
- Type: string
The source region where data is aggregated.
AggregatedSourceStatus
Description
The current sync status between the source and the aggregator account.
Members
- AwsRegion
-
- Type: string
The region authorized to collect aggregated data.
- LastErrorCode
-
- Type: string
The error code that Config returned when the source account aggregation last failed.
- LastErrorMessage
-
- Type: string
The message indicating that the source account aggregation failed due to an error.
- LastUpdateStatus
-
- Type: string
Filters the last updated status type.
-
Valid value FAILED indicates errors while moving data.
-
Valid value SUCCEEDED indicates the data was successfully moved.
-
Valid value OUTDATED indicates the data is not the most recent.
- LastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the last update.
- SourceId
-
- Type: string
The source account ID or an organization.
- SourceType
-
- Type: string
The source account or an organization.
AggregationAuthorization
Description
An object that represents the authorizations granted to aggregator accounts and regions.
Members
- AggregationAuthorizationArn
-
- Type: string
The Amazon Resource Name (ARN) of the aggregation object.
- AuthorizedAccountId
-
- Type: string
The 12-digit account ID of the account authorized to aggregate data.
- AuthorizedAwsRegion
-
- Type: string
The region authorized to collect aggregated data.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time stamp when the aggregation authorization was created.
BaseConfigurationItem
Description
The detailed configurations of a specified resource.
Members
- accountId
-
- Type: string
The 12-digit Amazon Web Services account ID associated with the resource.
- arn
-
- Type: string
The Amazon Resource Name (ARN) of the resource.
- availabilityZone
-
- Type: string
The Availability Zone associated with the resource.
- awsRegion
-
- Type: string
The region where the resource resides.
- configuration
-
- Type: string
The description of the resource configuration.
- configurationItemCaptureTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the recording of configuration changes was initiated for the resource.
- configurationItemDeliveryTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when configuration changes for the resource were delivered.
This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording, this field will be populated. However, if you are using continuous recording, this field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see Recording Frequency in the Config Developer Guide.
- configurationItemStatus
-
- Type: string
The configuration item status. Valid values include:
-
OK – The resource configuration has been updated.
-
ResourceDiscovered – The resource was newly discovered.
-
ResourceNotRecorded – The resource was discovered, but its configuration was not recorded since the recorder doesn't record resources of this type.
-
ResourceDeleted – The resource was deleted
-
ResourceDeletedNotRecorded – The resource was deleted, but its configuration was not recorded since the recorder doesn't record resources of this type.
- configurationStateId
-
- Type: string
An identifier that indicates the ordering of the configuration items of a resource.
- recordingFrequency
-
- Type: string
The recording frequency that Config uses to record configuration changes for the resource.
- resourceCreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time stamp when the resource was created.
- resourceId
-
- Type: string
The ID of the resource (for example., sg-xxxxxx).
- resourceName
-
- Type: string
The custom name of the resource, if available.
- resourceType
-
- Type: string
The type of Amazon Web Services resource.
- supplementaryConfiguration
-
- Type: Associative array of custom strings keys (SupplementaryConfigurationName) to strings
Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
- version
-
- Type: string
The version number of the resource configuration.
Compliance
Description
Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.
Members
- ComplianceContributorCount
-
- Type: ComplianceContributorCount structure
The number of Amazon Web Services resources or Config rules that cause a result of
NON_COMPLIANT
, up to a maximum number. - ComplianceType
-
- Type: string
Indicates whether an Amazon Web Services resource or Config rule is compliant.
A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.
Config returns the
INSUFFICIENT_DATA
value when no evaluation results are available for the Amazon Web Services resource or Config rule.For the
Compliance
data type, Config supports onlyCOMPLIANT
,NON_COMPLIANT
, andINSUFFICIENT_DATA
values. Config does not support theNOT_APPLICABLE
value for theCompliance
data type.
ComplianceByConfigRule
Description
Indicates whether an Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it. A rule is noncompliant if any of these resources do not comply.
Members
- Compliance
-
- Type: Compliance structure
Indicates whether the Config rule is compliant.
- ConfigRuleName
-
- Type: string
The name of the Config rule.
ComplianceByResource
Description
Indicates whether an Amazon Web Services resource that is evaluated according to one or more Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
Members
- Compliance
-
- Type: Compliance structure
Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.
- ResourceId
-
- Type: string
The ID of the Amazon Web Services resource that was evaluated.
- ResourceType
-
- Type: string
The type of the Amazon Web Services resource that was evaluated.
ComplianceContributorCount
Description
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item, up to a maximum number.
Members
- CapExceeded
-
- Type: boolean
Indicates whether the maximum count is reached.
- CappedCount
-
- Type: int
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
ComplianceSummary
Description
The number of Config rules or Amazon Web Services resources that are compliant and noncompliant.
Members
- ComplianceSummaryTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that Config created the compliance summary.
- CompliantResourceCount
-
- Type: ComplianceContributorCount structure
The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.
- NonCompliantResourceCount
-
- Type: ComplianceContributorCount structure
The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.
ComplianceSummaryByResourceType
Description
The number of Amazon Web Services resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each.
Members
- ComplianceSummary
-
- Type: ComplianceSummary structure
The number of Amazon Web Services resources that are compliant or noncompliant, up to a maximum of 100 for each.
- ResourceType
-
- Type: string
The type of Amazon Web Services resource.
ConfigExportDeliveryInfo
Description
Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.
Members
- lastAttemptTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the last attempted delivery.
- lastErrorCode
-
- Type: string
The error code from the last attempted delivery.
- lastErrorMessage
-
- Type: string
The error message from the last attempted delivery.
- lastStatus
-
- Type: string
Status of the last attempted delivery.
- lastSuccessfulTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the last successful delivery.
- nextDeliveryTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the next delivery occurs.
ConfigRule
Description
Config rules evaluate the configuration settings of your Amazon Web Services resources. A rule can run when Config detects a configuration change to an Amazon Web Services resource or at a periodic frequency that you choose (for example, every 24 hours). There are two types of rules: Config Managed Rules and Config Custom Rules.
Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
For more information about developing and using Config rules, see Evaluating Resource with Config Rules in the Config Developer Guide.
You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
Members
- ConfigRuleArn
-
- Type: string
The Amazon Resource Name (ARN) of the Config rule.
- ConfigRuleId
-
- Type: string
The ID of the Config rule.
- ConfigRuleName
-
- Type: string
The name that you assign to the Config rule. The name is required if you are adding a new rule.
- ConfigRuleState
-
- Type: string
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to
EVALUATING
temporarily after you use theStartConfigRulesEvaluation
request to evaluate your resources against the Config rule.Config sets the state of the rule to
DELETING_RESULTS
temporarily after you use theDeleteEvaluationResults
request to delete the current evaluation results for the Config rule.Config temporarily sets the state of a rule to
DELETING
after you use theDeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available. - CreatedBy
-
- Type: string
Service principal name of the service that created the rule.
The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
- Description
-
- Type: string
The description that you provide for the Config rule.
- EvaluationModes
-
- Type: Array of EvaluationModeConfiguration structures
The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
- InputParameters
-
- Type: string
A string, in JSON format, that is passed to the Config rule Lambda function.
- MaximumExecutionFrequency
-
- Type: string
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for
MaximumExecutionFrequency
when:-
This is for an Config managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the
MaximumExecutionFrequency
parameter. - Scope
-
- Type: Scope structure
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
The scope can be empty.
- Source
-
- Required: Yes
- Type: Source structure
Provides the rule owner (
Amazon Web Services
for managed rules,CUSTOM_POLICY
for Custom Policy rules, andCUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
ConfigRuleComplianceFilters
Description
Filters the compliance results based on account ID, region, compliance type, and rule name.
Members
- AccountId
-
- Type: string
The 12-digit account ID of the source account.
- AwsRegion
-
- Type: string
The source region where the data is aggregated.
- ComplianceType
-
- Type: string
The rule compliance status.
For the
ConfigRuleComplianceFilters
data type, Config supports onlyCOMPLIANT
andNON_COMPLIANT
. Config does not support theNOT_APPLICABLE
and theINSUFFICIENT_DATA
values. - ConfigRuleName
-
- Type: string
The name of the Config rule.
ConfigRuleComplianceSummaryFilters
Description
Filters the results based on the account IDs and regions.
Members
- AccountId
-
- Type: string
The 12-digit account ID of the source account.
- AwsRegion
-
- Type: string
The source region where the data is aggregated.
ConfigRuleEvaluationStatus
Description
Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.
This action does not return status information about Config Custom Lambda rules.
Members
- ConfigRuleArn
-
- Type: string
The Amazon Resource Name (ARN) of the Config rule.
- ConfigRuleId
-
- Type: string
The ID of the Config rule.
- ConfigRuleName
-
- Type: string
The name of the Config rule.
- FirstActivatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that you first activated the Config rule.
- FirstEvaluationStarted
-
- Type: boolean
Indicates whether Config has evaluated your resources against the rule at least once.
-
true
- Config has evaluated your Amazon Web Services resources against the rule at least once. -
false
- Config has not finished evaluating your Amazon Web Services resources against the rule at least once.
- LastDeactivatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that you last turned off the Config rule.
- LastDebugLogDeliveryStatus
-
- Type: string
The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either
Successful
orFailed
. - LastDebugLogDeliveryStatusReason
-
- Type: string
The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.
- LastDebugLogDeliveryTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time Config last attempted to deliver a debug log for your Config Custom Policy rules.
- LastErrorCode
-
- Type: string
The error code that Config returned when the rule last failed.
- LastErrorMessage
-
- Type: string
The error message that Config returned when the rule last failed.
- LastFailedEvaluationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that Config last failed to evaluate your Amazon Web Services resources against the rule.
- LastFailedInvocationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.
- LastSuccessfulEvaluationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that Config last successfully evaluated your Amazon Web Services resources against the rule.
- LastSuccessfulInvocationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.
ConfigSnapshotDeliveryProperties
Description
Provides options for how often Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.
The frequency for a rule that triggers evaluations for your resources when Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:
-
The value for the
deliveryFrequency
parameter within the delivery channel configuration, which sets how often Config delivers configuration snapshots. This value also sets how often Config invokes evaluations for Config rules. -
The value for the
MaximumExecutionFrequency
parameter, which sets the maximum frequency with which Config invokes evaluations for the rule. For more information, see ConfigRule.
If the deliveryFrequency
value is less frequent than the MaximumExecutionFrequency
value for a rule, Config invokes the rule only as often as the deliveryFrequency
value.
-
For example, you want your rule to run evaluations when Config delivers the configuration snapshot.
-
You specify the
MaximumExecutionFrequency
value forSix_Hours
. -
You then specify the delivery channel
deliveryFrequency
value forTwentyFour_Hours
. -
Because the value for
deliveryFrequency
is less frequent thanMaximumExecutionFrequency
, Config invokes evaluations for the rule every 24 hours.
You should set the MaximumExecutionFrequency
value to be at least as frequent as the deliveryFrequency
value. You can view the deliveryFrequency
value by using the DescribeDeliveryChannnels
action.
To update the deliveryFrequency
with which Config delivers your configuration snapshots, use the PutDeliveryChannel
action.
Members
- deliveryFrequency
-
- Type: string
The frequency with which Config delivers configuration snapshots.
ConfigStreamDeliveryInfo
Description
A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.
Members
- lastErrorCode
-
- Type: string
The error code from the last attempted delivery.
- lastErrorMessage
-
- Type: string
The error message from the last attempted delivery.
- lastStatus
-
- Type: string
Status of the last attempted delivery.
Note Providing an SNS topic on a DeliveryChannel for Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.
- lastStatusChangeTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time from the last status change.
ConfigurationAggregator
Description
The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.
Members
- AccountAggregationSources
-
- Type: Array of AccountAggregationSource structures
Provides a list of source accounts and regions to be aggregated.
- ConfigurationAggregatorArn
-
- Type: string
The Amazon Resource Name (ARN) of the aggregator.
- ConfigurationAggregatorName
-
- Type: string
The name of the aggregator.
- CreatedBy
-
- Type: string
Amazon Web Services service that created the configuration aggregator.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time stamp when the configuration aggregator was created.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the last update.
- OrganizationAggregationSource
-
- Type: OrganizationAggregationSource structure
Provides an organization and list of regions to be aggregated.
ConfigurationItem
Description
A list that contains detailed configurations of a specified resource.
Members
- accountId
-
- Type: string
The 12-digit Amazon Web Services account ID associated with the resource.
- arn
-
- Type: string
Amazon Resource Name (ARN) associated with the resource.
- availabilityZone
-
- Type: string
The Availability Zone associated with the resource.
- awsRegion
-
- Type: string
The region where the resource resides.
- configuration
-
- Type: string
The description of the resource configuration.
- configurationItemCaptureTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the recording of configuration changes was initiated for the resource.
- configurationItemDeliveryTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when configuration changes for the resource were delivered.
This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording, this field will be populated. However, if you are using continuous recording, this field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see Recording Frequency in the Config Developer Guide.
- configurationItemMD5Hash
-
- Type: string
Unique MD5 hash that represents the configuration item's state.
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
- configurationItemStatus
-
- Type: string
The configuration item status. Valid values include:
-
OK – The resource configuration has been updated
-
ResourceDiscovered – The resource was newly discovered
-
ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder doesn't record resources of this type
-
ResourceDeleted – The resource was deleted
-
ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder doesn't record resources of this type
- configurationStateId
-
- Type: string
An identifier that indicates the ordering of the configuration items of a resource.
- recordingFrequency
-
- Type: string
The recording frequency that Config uses to record configuration changes for the resource.
- relatedEvents
-
- Type: Array of strings
A list of CloudTrail event IDs.
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.
An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.
- relationships
-
- Type: Array of Relationship structures
A list of related Amazon Web Services resources.
- resourceCreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time stamp when the resource was created.
- resourceId
-
- Type: string
The ID of the resource (for example,
sg-xxxxxx
). - resourceName
-
- Type: string
The custom name of the resource, if available.
- resourceType
-
- Type: string
The type of Amazon Web Services resource.
- supplementaryConfiguration
-
- Type: Associative array of custom strings keys (SupplementaryConfigurationName) to strings
Configuration attributes that Config returns for certain resource types to supplement the information returned for the
configuration
parameter. - tags
-
- Type: Associative array of custom strings keys (Name) to strings
A mapping of key value tags associated with the resource.
- version
-
- Type: string
The version number of the resource configuration.
ConfigurationRecorder
Description
Records configuration changes to your specified resource types. For more information about the configuration recorder, see Managing the Configuration Recorder in the Config Developer Guide.
Members
- name
-
- Type: string
The name of the configuration recorder. Config automatically assigns the name of "default" when creating the configuration recorder.
You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.
- recordingGroup
-
- Type: RecordingGroup structure
Specifies which resource types Config records for configuration changes.
High Number of Config Evaluations
You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.
If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.
- recordingMode
-
- Type: RecordingMode structure
Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.
-
Continuous recording allows you to record configuration changes continuously whenever a change occurs.
-
Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.
Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.
You can also override the recording frequency for specific resource types.
- roleARN
-
- Type: string
Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.
While the API model does not require this field, the server will reject a request without a defined
roleARN
for the configuration recorder.Pre-existing Config role
If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected.
For example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see Identity and Access Management for Config in the Config Developer Guide.
ConfigurationRecorderStatus
Description
The current status of the configuration recorder.
For a detailed status of recording events over time, add your Config events to CloudWatch metrics and use CloudWatch metrics.
Members
- lastErrorCode
-
- Type: string
The latest error code from when the recorder last failed.
- lastErrorMessage
-
- Type: string
The latest error message from when the recorder last failed.
- lastStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the recorder was last started.
- lastStatus
-
- Type: string
The status of the latest recording event processed by the recorder.
- lastStatusChangeTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the latest change in status of an recording event processed by the recorder.
- lastStopTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the recorder was last stopped.
- name
-
- Type: string
The name of the configuration recorder.
- recording
-
- Type: boolean
Specifies whether or not the recorder is currently recording.
ConformancePackComplianceFilters
Description
Filters the conformance pack by compliance types and Config rule names.
Members
- ComplianceType
-
- Type: string
Filters the results by compliance.
The allowed values are
COMPLIANT
andNON_COMPLIANT
.INSUFFICIENT_DATA
is not supported. - ConfigRuleNames
-
- Type: Array of strings
Filters the results by Config rule names.
ConformancePackComplianceScore
Description
A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.
Members
- ConformancePackName
-
- Type: string
The name of the conformance pack.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the conformance pack compliance score was last updated.
- Score
-
- Type: string
Compliance score for the conformance pack. Conformance packs with no evaluation results will have a compliance score of
INSUFFICIENT_DATA
.
ConformancePackComplianceScoresFilters
Description
A list of filters to apply to the conformance pack compliance score result set.
Members
- ConformancePackNames
-
- Required: Yes
- Type: Array of strings
The names of the conformance packs whose compliance scores you want to include in the conformance pack compliance score result set. You can include up to 25 conformance packs in the
ConformancePackNames
array of strings, each with a character limit of 256 characters for the conformance pack name.
ConformancePackComplianceSummary
Description
Summary includes the name and status of the conformance pack.
Members
- ConformancePackComplianceStatus
-
- Required: Yes
- Type: string
The status of the conformance pack.
- ConformancePackName
-
- Required: Yes
- Type: string
The name of the conformance pack name.
ConformancePackDetail
Description
Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.
Members
- ConformancePackArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of the conformance pack.
- ConformancePackId
-
- Required: Yes
- Type: string
ID of the conformance pack.
- ConformancePackInputParameters
-
- Type: Array of ConformancePackInputParameter structures
A list of
ConformancePackInputParameter
objects. - ConformancePackName
-
- Required: Yes
- Type: string
Name of the conformance pack.
- CreatedBy
-
- Type: string
The Amazon Web Services service that created the conformance pack.
- DeliveryS3Bucket
-
- Type: string
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional.
- DeliveryS3KeyPrefix
-
- Type: string
The prefix for the Amazon S3 bucket.
This field is optional.
- LastUpdateRequestedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time a conformation pack update was requested.
- TemplateSSMDocumentDetails
-
- Type: TemplateSSMDocumentDetails structure
An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.
ConformancePackEvaluationFilters
Description
Filters a conformance pack by Config rule names, compliance types, Amazon Web Services resource types, and resource IDs.
Members
- ComplianceType
-
- Type: string
Filters the results by compliance.
The allowed values are
COMPLIANT
andNON_COMPLIANT
.INSUFFICIENT_DATA
is not supported. - ConfigRuleNames
-
- Type: Array of strings
Filters the results by Config rule names.
- ResourceIds
-
- Type: Array of strings
Filters the results by resource IDs.
This is valid only when you provide resource type. If there is no resource type, you will see an error.
- ResourceType
-
- Type: string
Filters the results by the resource type (for example,
"AWS::EC2::Instance"
).
ConformancePackEvaluationResult
Description
The details of a conformance pack evaluation. Provides Config rule and Amazon Web Services resource type that was evaluated, the compliance of the conformance pack, related time stamps, and supplementary information.
Members
- Annotation
-
- Type: string
Supplementary information about how the evaluation determined the compliance.
- ComplianceType
-
- Required: Yes
- Type: string
The compliance type. The allowed values are
COMPLIANT
andNON_COMPLIANT
.INSUFFICIENT_DATA
is not supported. - ConfigRuleInvokedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when Config rule evaluated Amazon Web Services resource.
- EvaluationResultIdentifier
-
- Required: Yes
- Type: EvaluationResultIdentifier structure
Uniquely identifies an evaluation result.
- ResultRecordedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when Config recorded the evaluation result.
ConformancePackInputParameter
Description
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
Members
- ParameterName
-
- Required: Yes
- Type: string
One part of a key-value pair.
- ParameterValue
-
- Required: Yes
- Type: string
Another part of the key-value pair.
ConformancePackRuleCompliance
Description
Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.
Members
- ComplianceType
-
- Type: string
Compliance of the Config rule.
- ConfigRuleName
-
- Type: string
Name of the Config rule.
- Controls
-
- Type: Array of strings
Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.
ConformancePackStatusDetail
Description
Status details of a conformance pack.
Members
- ConformancePackArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of comformance pack.
- ConformancePackId
-
- Required: Yes
- Type: string
ID of the conformance pack.
- ConformancePackName
-
- Required: Yes
- Type: string
Name of the conformance pack.
- ConformancePackState
-
- Required: Yes
- Type: string
Indicates deployment status of conformance pack.
Config sets the state of the conformance pack to:
-
CREATE_IN_PROGRESS when a conformance pack creation is in progress for an account.
-
CREATE_COMPLETE when a conformance pack has been successfully created in your account.
-
CREATE_FAILED when a conformance pack creation failed in your account.
-
DELETE_IN_PROGRESS when a conformance pack deletion is in progress.
-
DELETE_FAILED when a conformance pack deletion failed in your account.
- ConformancePackStatusReason
-
- Type: string
The reason of conformance pack creation failure.
- LastUpdateCompletedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Last time when conformation pack creation and update was successful.
- LastUpdateRequestedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Last time when conformation pack creation and update was requested.
- StackArn
-
- Required: Yes
- Type: string
Amazon Resource Name (ARN) of CloudFormation stack.
ConformancePackTemplateValidationException
Description
You have specified a template that is not valid or supported.
Members
CustomPolicyDetails
Description
Provides the runtime system, policy definition, and whether debug logging enabled. You can specify the following CustomPolicyDetails parameter values only for Config Custom Policy rules.
Members
- EnableDebugLogDelivery
-
- Type: boolean
The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is
false
. - PolicyRuntime
-
- Required: Yes
- Type: string
The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.
- PolicyText
-
- Required: Yes
- Type: string
The policy definition containing the logic for your Config Custom Policy rule.
DeliveryChannel
Description
The channel through which Config delivers notifications and updated configuration states.
Members
- configSnapshotDeliveryProperties
-
- Type: ConfigSnapshotDeliveryProperties structure
The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.
- name
-
- Type: string
The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.
- s3BucketName
-
- Type: string
The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.
If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.
- s3KeyPrefix
-
- Type: string
The prefix for the specified Amazon S3 bucket.
- s3KmsKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.
- snsTopicARN
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.
If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.
DeliveryChannelStatus
Description
The status of a specified delivery channel.
Valid values: Success
| Failure
Members
- configHistoryDeliveryInfo
-
- Type: ConfigExportDeliveryInfo structure
A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
- configSnapshotDeliveryInfo
-
- Type: ConfigExportDeliveryInfo structure
A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
- configStreamDeliveryInfo
-
- Type: ConfigStreamDeliveryInfo structure
A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.
- name
-
- Type: string
The name of the delivery channel.
DescribeConfigRulesFilters
Description
Returns a filtered list of Detective or Proactive Config rules. By default, if the filter is not defined, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.
Members
- EvaluationMode
-
- Type: string
The mode of an evaluation. The valid values are Detective or Proactive.
Evaluation
Description
Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.
Members
- Annotation
-
- Type: string
Supplementary information about how the evaluation determined the compliance.
- ComplianceResourceId
-
- Required: Yes
- Type: string
The ID of the Amazon Web Services resource that was evaluated.
- ComplianceResourceType
-
- Required: Yes
- Type: string
The type of Amazon Web Services resource that was evaluated.
- ComplianceType
-
- Required: Yes
- Type: string
Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.
For the
Evaluation
data type, Config supports only theCOMPLIANT
,NON_COMPLIANT
, andNOT_APPLICABLE
values. Config does not support theINSUFFICIENT_DATA
value for this data type.Similarly, Config does not accept
INSUFFICIENT_DATA
as the value forComplianceType
from aPutEvaluations
request. For example, an Lambda function for a custom Config rule cannot pass anINSUFFICIENT_DATA
value to Config. - OrderingTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).
EvaluationContext
Description
Use EvaluationContext to group independently initiated proactive resource evaluations. For example, CFN Stack. If you want to check just a resource definition, you do not need to provide evaluation context.
Members
- EvaluationContextIdentifier
-
- Type: string
A unique EvaluationContextIdentifier ID for an EvaluationContext.
EvaluationModeConfiguration
Description
The configuration object for Config rule evaluation mode. The supported valid values are Detective or Proactive.
Members
- Mode
-
- Type: string
The mode of an evaluation. The valid values are Detective or Proactive.
EvaluationResult
Description
The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
Members
- Annotation
-
- Type: string
Supplementary information about how the evaluation determined the compliance.
- ComplianceType
-
- Type: string
Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.
For the
EvaluationResult
data type, Config supports only theCOMPLIANT
,NON_COMPLIANT
, andNOT_APPLICABLE
values. Config does not support theINSUFFICIENT_DATA
value for theEvaluationResult
data type. - ConfigRuleInvokedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the Config rule evaluated the Amazon Web Services resource.
- EvaluationResultIdentifier
-
- Type: EvaluationResultIdentifier structure
Uniquely identifies the evaluation result.
- ResultRecordedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when Config recorded the evaluation result.
- ResultToken
-
- Type: string
An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.
EvaluationResultIdentifier
Description
Uniquely identifies an evaluation result.
Members
- EvaluationResultQualifier
-
- Type: EvaluationResultQualifier structure
Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
- OrderingTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
- ResourceEvaluationId
-
- Type: string
A Unique ID for an evaluation result.
EvaluationResultQualifier
Description
Identifies an Config rule that evaluated an Amazon Web Services resource, and provides the type and ID of the resource that the rule evaluated.
Members
- ConfigRuleName
-
- Type: string
The name of the Config rule that was used in the evaluation.
- EvaluationMode
-
- Type: string
The mode of an evaluation. The valid values are Detective or Proactive.
- ResourceId
-
- Type: string
The ID of the evaluated Amazon Web Services resource.
- ResourceType
-
- Type: string
The type of Amazon Web Services resource that was evaluated.
EvaluationStatus
Description
Returns status details of an evaluation.
Members
- FailureReason
-
- Type: string
An explanation for failed execution status.
- Status
-
- Required: Yes
- Type: string
The status of an execution. The valid values are In_Progress, Succeeded or Failed.
ExclusionByResourceTypes
Description
Specifies whether the configuration recorder excludes certain resource types from being recorded. Use the resourceTypes
field to enter a comma-separated list of resource types you want to exclude from recording.
By default, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.
How to use the exclusion recording strategy
To use this option, you must set the useOnly
field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES
.
Config will then record configuration changes for all supported resource types, except the resource types that you specify to