list-discovered-resources¶

Description¶

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.

Note

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.

Synopsis¶

  list-discovered-resources
--resource-type <value>
[--resource-ids <value>]
[--resource-name <value>]
[--include-deleted-resources | --no-include-deleted-resources]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--resource-type (string)

The type of resources that you want Config to list in the response.

Possible values:

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

--resource-ids (list)

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.

(string)

Syntax:

"string" "string" ...

--resource-name (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.

--include-deleted-resources | --no-include-deleted-resources (boolean)

Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list resources that AWS Config has discovered

The following command lists the EC2 instances that AWS Config has discovered:

aws configservice list-discovered-resources --resource-type AWS::EC2::Instance

Output:

{
    "resourceIdentifiers": [
        {
            "resourceType": "AWS::EC2::Instance",
            "resourceId": "i-1a2b3c4d"
        },
        {
            "resourceType": "AWS::EC2::Instance",
            "resourceId": "i-2a2b3c4d"
        },
        {
            "resourceType": "AWS::EC2::Instance",
            "resourceId": "i-3a2b3c4d"
        }
    ]
}

Output¶

resourceIdentifiers -> (list)

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

(structure)

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

resourceType -> (string)

The type of resource.

resourceId -> (string)

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

resourceName -> (string)

The custom name of the resource (if available).

resourceDeletionTime -> (timestamp)

The time that the resource was deleted.

nextToken -> (string)

The string that you use in a subsequent request to get the next page of results in a paginated response.

Table of Contents

Feedback

User Guide