/ - AWS Config

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.

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

resourceKeys

array[object (ResourceKey) {2}]

required

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.

>= 1 items<= 100 items

resourceType

enum<string>

required

The resource type.

Allowed values:

AWS::EC2::CustomerGatewayAWS::EC2::EIPAWS::EC2::HostAWS::EC2::InstanceAWS::EC2::InternetGatewayAWS::EC2::NetworkAclAWS::EC2::NetworkInterfaceAWS::EC2::RouteTableAWS::EC2::SecurityGroupAWS::EC2::SubnetAWS::CloudTrail::TrailAWS::EC2::VolumeAWS::EC2::VPCAWS::EC2::VPNConnectionAWS::EC2::VPNGatewayAWS::EC2::RegisteredHAInstanceAWS::EC2::NatGatewayAWS::EC2::EgressOnlyInternetGatewayAWS::EC2::VPCEndpointAWS::EC2::VPCEndpointServiceAWS::EC2::FlowLogAWS::EC2::VPCPeeringConnectionAWS::Elasticsearch::DomainAWS::IAM::GroupAWS::IAM::PolicyAWS::IAM::RoleAWS::IAM::UserAWS::ElasticLoadBalancingV2::LoadBalancerAWS::ACM::CertificateAWS::RDS::DBInstanceAWS::RDS::DBSubnetGroupAWS::RDS::DBSecurityGroupAWS::RDS::DBSnapshotAWS::RDS::DBClusterAWS::RDS::DBClusterSnapshotAWS::RDS::EventSubscriptionAWS::S3::BucketAWS::S3::AccountPublicAccessBlockAWS::Redshift::ClusterAWS::Redshift::ClusterSnapshotAWS::Redshift::ClusterParameterGroupAWS::Redshift::ClusterSecurityGroupAWS::Redshift::ClusterSubnetGroupAWS::Redshift::EventSubscriptionAWS::SSM::ManagedInstanceInventoryAWS::CloudWatch::AlarmAWS::CloudFormation::StackAWS::ElasticLoadBalancing::LoadBalancerAWS::AutoScaling::AutoScalingGroupAWS::AutoScaling::LaunchConfigurationAWS::AutoScaling::ScalingPolicyAWS::AutoScaling::ScheduledActionAWS::DynamoDB::TableAWS::CodeBuild::ProjectAWS::WAF::RateBasedRuleAWS::WAF::RuleAWS::WAF::RuleGroupAWS::WAF::WebACLAWS::WAFRegional::RateBasedRuleAWS::WAFRegional::RuleAWS::WAFRegional::RuleGroupAWS::WAFRegional::WebACLAWS::CloudFront::DistributionAWS::CloudFront::StreamingDistributionAWS::Lambda::FunctionAWS::NetworkFirewall::FirewallAWS::NetworkFirewall::FirewallPolicyAWS::NetworkFirewall::RuleGroupAWS::ElasticBeanstalk::ApplicationAWS::ElasticBeanstalk::ApplicationVersionAWS::ElasticBeanstalk::EnvironmentAWS::WAFv2::WebACLAWS::WAFv2::RuleGroupAWS::WAFv2::IPSetAWS::WAFv2::RegexPatternSetAWS::WAFv2::ManagedRuleSetAWS::XRay::EncryptionConfigAWS::SSM::AssociationComplianceAWS::SSM::PatchComplianceAWS::Shield::ProtectionAWS::ShieldRegional::ProtectionAWS::Config::ConformancePackComplianceAWS::Config::ResourceComplianceAWS::ApiGateway::StageAWS::ApiGateway::RestApiAWS::ApiGatewayV2::StageAWS::ApiGatewayV2::ApiAWS::CodePipeline::PipelineAWS::ServiceCatalog::CloudFormationProvisionedProductAWS::ServiceCatalog::CloudFormationProductAWS::ServiceCatalog::PortfolioAWS::SQS::QueueAWS::KMS::KeyAWS::QLDB::LedgerAWS::SecretsManager::SecretAWS::SNS::TopicAWS::SSM::FileDataAWS::Backup::BackupPlanAWS::Backup::BackupSelectionAWS::Backup::BackupVaultAWS::Backup::RecoveryPointAWS::ECR::RepositoryAWS::ECS::ClusterAWS::ECS::ServiceAWS::ECS::TaskDefinitionAWS::EFS::AccessPointAWS::EFS::FileSystemAWS::EKS::ClusterAWS::OpenSearch::DomainAWS::EC2::TransitGatewayAWS::Kinesis::StreamAWS::Kinesis::StreamConsumerAWS::CodeDeploy::ApplicationAWS::CodeDeploy::DeploymentConfigAWS::CodeDeploy::DeploymentGroupAWS::EC2::LaunchTemplateAWS::ECR::PublicRepositoryAWS::GuardDuty::DetectorAWS::EMR::SecurityConfigurationAWS::SageMaker::CodeRepositoryAWS::Route53Resolver::ResolverEndpointAWS::Route53Resolver::ResolverRuleAWS::Route53Resolver::ResolverRuleAssociationAWS::DMS::ReplicationSubnetGroupAWS::DMS::EventSubscriptionAWS::MSK::ClusterAWS::StepFunctions::ActivityAWS::WorkSpaces::WorkspaceAWS::WorkSpaces::ConnectionAliasAWS::SageMaker::ModelAWS::ElasticLoadBalancingV2::ListenerAWS::StepFunctions::StateMachineAWS::Batch::JobQueueAWS::Batch::ComputeEnvironmentAWS::AccessAnalyzer::AnalyzerAWS::Athena::WorkGroupAWS::Athena::DataCatalogAWS::Detective::GraphAWS::GlobalAccelerator::AcceleratorAWS::GlobalAccelerator::EndpointGroupAWS::GlobalAccelerator::ListenerAWS::EC2::TransitGatewayAttachmentAWS::EC2::TransitGatewayRouteTableAWS::DMS::CertificateAWS::AppConfig::ApplicationAWS::AppSync::GraphQLApiAWS::DataSync::LocationSMBAWS::DataSync::LocationFSxLustreAWS::DataSync::LocationS3AWS::DataSync::LocationEFSAWS::DataSync::TaskAWS::DataSync::LocationNFSAWS::EC2::NetworkInsightsAccessScopeAnalysisAWS::EKS::FargateProfileAWS::Glue::JobAWS::GuardDuty::ThreatIntelSetAWS::GuardDuty::IPSetAWS::SageMaker::WorkteamAWS::SageMaker::NotebookInstanceLifecycleConfigAWS::ServiceDiscovery::ServiceAWS::ServiceDiscovery::PublicDnsNamespaceAWS::SES::ContactListAWS::SES::ConfigurationSetAWS::Route53::HostedZoneAWS::IoTEvents::InputAWS::IoTEvents::DetectorModelAWS::IoTEvents::AlarmModelAWS::ServiceDiscovery::HttpNamespaceAWS::Events::EventBusAWS::ImageBuilder::ContainerRecipeAWS::ImageBuilder::DistributionConfigurationAWS::ImageBuilder::InfrastructureConfigurationAWS::DataSync::LocationObjectStorageAWS::DataSync::LocationHDFSAWS::Glue::ClassifierAWS::Route53RecoveryReadiness::CellAWS::Route53RecoveryReadiness::ReadinessCheckAWS::ECR::RegistryPolicyAWS::Backup::ReportPlanAWS::Lightsail::CertificateAWS::RUM::AppMonitorAWS::Events::EndpointAWS::SES::ReceiptRuleSetAWS::Events::ArchiveAWS::Events::ApiDestinationAWS::Lightsail::DiskAWS::FIS::ExperimentTemplateAWS::DataSync::LocationFSxWindowsAWS::SES::ReceiptFilterAWS::GuardDuty::FilterAWS::SES::TemplateAWS::AmazonMQ::BrokerAWS::AppConfig::EnvironmentAWS::AppConfig::ConfigurationProfileAWS::Cloud9::EnvironmentEC2AWS::EventSchemas::RegistryAWS::EventSchemas::RegistryPolicyAWS::EventSchemas::DiscovererAWS::FraudDetector::LabelAWS::FraudDetector::EntityTypeAWS::FraudDetector::VariableAWS::FraudDetector::OutcomeAWS::IoT::AuthorizerAWS::IoT::SecurityProfileAWS::IoT::RoleAliasAWS::IoT::DimensionAWS::IoTAnalytics::DatastoreAWS::Lightsail::BucketAWS::Lightsail::StaticIpAWS::MediaPackage::PackagingGroupAWS::Route53RecoveryReadiness::RecoveryGroupAWS::ResilienceHub::ResiliencyPolicyAWS::Transfer::WorkflowAWS::EKS::IdentityProviderConfigAWS::EKS::AddonAWS::Glue::MLTransformAWS::IoT::PolicyAWS::IoT::MitigationActionAWS::IoTTwinMaker::WorkspaceAWS::IoTTwinMaker::EntityAWS::IoTAnalytics::DatasetAWS::IoTAnalytics::PipelineAWS::IoTAnalytics::ChannelAWS::IoTSiteWise::DashboardAWS::IoTSiteWise::ProjectAWS::IoTSiteWise::PortalAWS::IoTSiteWise::AssetModelAWS::IVS::ChannelAWS::IVS::RecordingConfigurationAWS::IVS::PlaybackKeyPairAWS::KinesisAnalyticsV2::ApplicationAWS::RDS::GlobalClusterAWS::S3::MultiRegionAccessPointAWS::DeviceFarm::TestGridProjectAWS::Budgets::BudgetsActionAWS::Lex::BotAWS::CodeGuruReviewer::RepositoryAssociationAWS::IoT::CustomMetricAWS::Route53Resolver::FirewallDomainListAWS::RoboMaker::RobotApplicationVersionAWS::EC2::TrafficMirrorSessionAWS::IoTSiteWise::GatewayAWS::Lex::BotAliasAWS::LookoutMetrics::AlertAWS::IoT::AccountAuditConfigurationAWS::EC2::TrafficMirrorTargetAWS::S3::StorageLensAWS::IoT::ScheduledAuditAWS::Events::ConnectionAWS::EventSchemas::SchemaAWS::MediaPackage::PackagingConfigurationAWS::KinesisVideo::SignalingChannelAWS::AppStream::DirectoryConfigAWS::LookoutVision::ProjectAWS::Route53RecoveryControl::ClusterAWS::Route53RecoveryControl::SafetyRuleAWS::Route53RecoveryControl::ControlPanelAWS::Route53RecoveryControl::RoutingControlAWS::Route53RecoveryReadiness::ResourceSetAWS::RoboMaker::SimulationApplicationAWS::RoboMaker::RobotApplicationAWS::HealthLake::FHIRDatastoreAWS::Pinpoint::SegmentAWS::Pinpoint::ApplicationSettingsAWS::Events::RuleAWS::EC2::DHCPOptionsAWS::EC2::NetworkInsightsPathAWS::EC2::TrafficMirrorFilterAWS::EC2::IPAMAWS::IoTTwinMaker::SceneAWS::NetworkManager::TransitGatewayRegistrationAWS::CustomerProfiles::DomainAWS::AutoScaling::WarmPoolAWS::Connect::PhoneNumber

resourceId

string

required

The ID of the resource (for example., sg-xxxxxx).

>= 1 characters<= 768 characters

Examples

Responses

🟢200Success

application/json

Body

baseConfigurationItems

array[object (BaseConfigurationItem) {14}]

optional

A list that contains the current configuration of one or more resources.

version

string

optional

The version number of the resource configuration.

accountId

string

optional

The 12-digit Amazon Web Services account ID associated with the resource.

Match pattern:

\d{12}

configurationItemCaptureTime

string <date-time>

optional

The time when the configuration recording was initiated.

configurationItemStatus

enum<string>

optional

The configuration item status. The valid values are:

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 excludes the recording of resources of this type
ResourceDeleted – The resource was deleted
ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

Allowed values:

OKResourceDiscoveredResourceNotRecordedResourceDeletedResourceDeletedNotRecorded

configurationStateId

string

optional

An identifier that indicates the ordering of the configuration items of a resource.

arn

string

optional

The Amazon Resource Name (ARN) of the resource.

resourceType

enum<string>

optional

The type of Amazon Web Services resource.

Allowed values:

resourceId

string

optional

The ID of the resource (for example., sg-xxxxxx).

>= 1 characters<= 768 characters

resourceName

string

optional

The custom name of the resource, if available.

awsRegion

string

optional

The region where the resource resides.

>= 1 characters<= 64 characters

availabilityZone

string

optional

The Availability Zone associated with the resource.

resourceCreationTime

string <date-time>

optional

The time stamp when the resource was created.

configuration

string

optional

The description of the resource configuration.

supplementaryConfiguration

object

optional

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

unprocessedResourceKeys

array[object (ResourceKey) {2}]

optional

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.

>= 1 items<= 100 items

resourceType

enum<string>

required

The resource type.

Allowed values:

resourceId

string

required

The ID of the resource (for example., sg-xxxxxx).

>= 1 characters<= 768 characters

🟠480ValidationException

🟠481NoAvailableConfigurationRecorderException