AWS CLI Command Reference

[ aws . configservice ]

list-aggregate-discovered-resources

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-aggregate-discovered-resources is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ResourceIdentifiers

Synopsis

  list-aggregate-discovered-resources
--configuration-aggregator-name <value>
--resource-type <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--configuration-aggregator-name (string)

The name of the configuration aggregator.

--resource-type (string)

The type of resources that you want AWS 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::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::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

--filters (structure)

Filters the results based on the ResourceFilters object.

AccountId -> (string)

The 12-digit source account ID.

ResourceId -> (string)

The ID of the resource.

ResourceName -> (string)

The name of the resource.

Region -> (string)

The source region.

Shorthand Syntax:

AccountId=string,ResourceId=string,ResourceName=string,Region=string

JSON Syntax:

{
  "AccountId": "string",
  "ResourceId": "string",
  "ResourceName": "string",
  "Region": "string"
}

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ResourceIdentifiers -> (list)

Returns a list of ResourceIdentifiers objects.

(structure)

The details that identify a resource that is collected by AWS Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.

SourceAccountId -> (string)

The 12-digit account ID of the source account.

SourceRegion -> (string)

The source region where data is aggregated.

ResourceId -> (string)

The ID of the AWS resource.

ResourceType -> (string)

The type of the AWS resource.

ResourceName -> (string)

The name of the AWS resource.

NextToken -> (string)

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

© Copyright 2018, Amazon Web Services. Created using Sphinx.