You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ConfigService

Inherits:
AWS.Service show all
Identifier:
configservice
API Version:
2014-11-12
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see Supported Amazon Web Services resources.

You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer Guide.

Sending a Request Using ConfigService

var configservice = new AWS.ConfigService();
configservice.batchGetAggregateResourceConfig(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ConfigService object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var configservice = new AWS.ConfigService({apiVersion: '2014-11-12'});

You can also set the API version globally in AWS.config.apiVersions using the configservice service identifier:

AWS.config.apiVersions = {
  configservice: '2014-11-12',
  // other service API versions
};

var configservice = new AWS.ConfigService();

Version:

  • 2014-11-12

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ConfigService(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ConfigService object

var configservice = new AWS.ConfigService({apiVersion: '2014-11-12'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.ConfigService.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.ConfigService.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.ConfigService.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchGetAggregateResourceConfig(params = {}, callback) ⇒ AWS.Request

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.

Note:
  • The API does not return results for deleted resources.
  • The API does not return tags and relationships.

Service Reference:

Examples:

Calling the batchGetAggregateResourceConfig operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  ResourceIdentifiers: [ /* required */
    {
      ResourceId: 'STRING_VALUE', /* 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, /* required */
      SourceAccountId: 'STRING_VALUE', /* required */
      SourceRegion: 'STRING_VALUE', /* required */
      ResourceName: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.batchGetAggregateResourceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • ResourceIdentifiers — (Array<map>)

      A list of aggregate ResourceIdentifiers objects.

      • SourceAccountId — required — (String)

        The 12-digit account ID of the source account.

      • SourceRegion — required — (String)

        The source region where data is aggregated.

      • ResourceId — required — (String)

        The ID of the Amazon Web Services resource.

      • ResourceType — required — (String)

        The type of the Amazon Web Services resource.

        Possible values include:
        • "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"
      • ResourceName — (String)

        The name of the Amazon Web Services resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BaseConfigurationItems — (Array<map>)

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

        • version — (String)

          The version number of the resource configuration.

        • accountId — (String)

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

        • configurationItemCaptureTime — (Date)

          The time when the configuration recording was initiated.

        • configurationItemStatus — (String)

          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

          Note: The CIs do not incur any cost.
          Possible values include:
          • "OK"
          • "ResourceDiscovered"
          • "ResourceNotRecorded"
          • "ResourceDeleted"
          • "ResourceDeletedNotRecorded"
        • configurationStateId — (String)

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

        • arn — (String)

          The Amazon Resource Name (ARN) of the resource.

        • resourceType — (String)

          The type of Amazon Web Services resource.

          Possible values include:
          • "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"
        • resourceId — (String)

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

        • resourceName — (String)

          The custom name of the resource, if available.

        • awsRegion — (String)

          The region where the resource resides.

        • availabilityZone — (String)

          The Availability Zone associated with the resource.

        • resourceCreationTime — (Date)

          The time stamp when the resource was created.

        • configuration — (String)

          The description of the resource configuration.

        • supplementaryConfiguration — (map<String>)

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

      • UnprocessedResourceIdentifiers — (Array<map>)

        A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.

        • SourceAccountId — required — (String)

          The 12-digit account ID of the source account.

        • SourceRegion — required — (String)

          The source region where data is aggregated.

        • ResourceId — required — (String)

          The ID of the Amazon Web Services resource.

        • ResourceType — required — (String)

          The type of the Amazon Web Services resource.

          Possible values include:
          • "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"
        • ResourceName — (String)

          The name of the Amazon Web Services resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

batchGetResourceConfig(params = {}, callback) ⇒ AWS.Request

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.

Note:
  • 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.

Service Reference:

Examples:

Calling the batchGetResourceConfig operation

var params = {
  resourceKeys: [ /* required */
    {
      resourceId: 'STRING_VALUE', /* 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 /* required */
    },
    /* more items */
  ]
};
configservice.batchGetResourceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceKeys — (Array<map>)

      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.

      • resourceType — required — (String)

        The resource type.

        Possible values include:
        • "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"
      • resourceId — required — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • baseConfigurationItems — (Array<map>)

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

        • version — (String)

          The version number of the resource configuration.

        • accountId — (String)

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

        • configurationItemCaptureTime — (Date)

          The time when the configuration recording was initiated.

        • configurationItemStatus — (String)

          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

          Note: The CIs do not incur any cost.
          Possible values include:
          • "OK"
          • "ResourceDiscovered"
          • "ResourceNotRecorded"
          • "ResourceDeleted"
          • "ResourceDeletedNotRecorded"
        • configurationStateId — (String)

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

        • arn — (String)

          The Amazon Resource Name (ARN) of the resource.

        • resourceType — (String)

          The type of Amazon Web Services resource.

          Possible values include:
          • "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"
        • resourceId — (String)

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

        • resourceName — (String)

          The custom name of the resource, if available.

        • awsRegion — (String)

          The region where the resource resides.

        • availabilityZone — (String)

          The Availability Zone associated with the resource.

        • resourceCreationTime — (Date)

          The time stamp when the resource was created.

        • configuration — (String)

          The description of the resource configuration.

        • supplementaryConfiguration — (map<String>)

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

      • unprocessedResourceKeys — (Array<map>)

        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.

        • resourceType — required — (String)

          The resource type.

          Possible values include:
          • "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"
        • resourceId — required — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteAggregationAuthorization(params = {}, callback) ⇒ AWS.Request

Deletes the authorization granted to the specified configuration aggregator account in a specified region.

Service Reference:

Examples:

Calling the deleteAggregationAuthorization operation

var params = {
  AuthorizedAccountId: 'STRING_VALUE', /* required */
  AuthorizedAwsRegion: 'STRING_VALUE' /* required */
};
configservice.deleteAggregationAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AuthorizedAccountId — (String)

      The 12-digit account ID of the account authorized to aggregate data.

    • AuthorizedAwsRegion — (String)

      The region authorized to collect aggregated data.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConfigRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteConfigRule operation

var params = {
  ConfigRuleName: 'STRING_VALUE' /* required */
};
configservice.deleteConfigRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The name of the Config rule that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConfigurationAggregator(params = {}, callback) ⇒ AWS.Request

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

Service Reference:

Examples:

Calling the deleteConfigurationAggregator operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE' /* required */
};
configservice.deleteConfigurationAggregator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConfigurationRecorder(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteConfigurationRecorder operation

var params = {
  ConfigurationRecorderName: 'STRING_VALUE' /* required */
};
configservice.deleteConfigurationRecorder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationRecorderName — (String)

      The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConformancePack(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteConformancePack operation

var params = {
  ConformancePackName: 'STRING_VALUE' /* required */
};
configservice.deleteConformancePack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConformancePackName — (String)

      Name of the conformance pack you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDeliveryChannel(params = {}, callback) ⇒ AWS.Request

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Service Reference:

Examples:

Calling the deleteDeliveryChannel operation

var params = {
  DeliveryChannelName: 'STRING_VALUE' /* required */
};
configservice.deleteDeliveryChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeliveryChannelName — (String)

      The name of the delivery channel to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEvaluationResults(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteEvaluationResults operation

var params = {
  ConfigRuleName: 'STRING_VALUE' /* required */
};
configservice.deleteEvaluationResults(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The name of the Config rule for which you want to delete the evaluation results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteOrganizationConfigRule(params = {}, callback) ⇒ AWS.Request

Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization.

Only a master 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.

Service Reference:

Examples:

Calling the deleteOrganizationConfigRule operation

var params = {
  OrganizationConfigRuleName: 'STRING_VALUE' /* required */
};
configservice.deleteOrganizationConfigRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConfigRuleName — (String)

      The name of organization config rule that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteOrganizationConformancePack(params = {}, callback) ⇒ AWS.Request

Deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization.

Only a master 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.

Service Reference:

Examples:

Calling the deleteOrganizationConformancePack operation

var params = {
  OrganizationConformancePackName: 'STRING_VALUE' /* required */
};
configservice.deleteOrganizationConformancePack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConformancePackName — (String)

      The name of organization conformance pack that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePendingAggregationRequest(params = {}, callback) ⇒ AWS.Request

Deletes pending authorization requests for a specified aggregator account in a specified region.

Service Reference:

Examples:

Calling the deletePendingAggregationRequest operation

var params = {
  RequesterAccountId: 'STRING_VALUE', /* required */
  RequesterAwsRegion: 'STRING_VALUE' /* required */
};
configservice.deletePendingAggregationRequest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RequesterAccountId — (String)

      The 12-digit account ID of the account requesting to aggregate data.

    • RequesterAwsRegion — (String)

      The region requesting to aggregate data.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRemediationConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the remediation configuration.

Service Reference:

Examples:

Calling the deleteRemediationConfiguration operation

var params = {
  ConfigRuleName: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE'
};
configservice.deleteRemediationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The name of the Config rule for which you want to delete remediation configuration.

    • ResourceType — (String)

      The type of a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRemediationExceptions(params = {}, callback) ⇒ AWS.Request

Deletes one or more remediation exceptions mentioned in the resource keys.

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

Service Reference:

Examples:

Calling the deleteRemediationExceptions operation

var params = {
  ConfigRuleName: 'STRING_VALUE', /* required */
  ResourceKeys: [ /* required */
    {
      ResourceId: 'STRING_VALUE',
      ResourceType: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.deleteRemediationExceptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The name of the Config rule for which you want to delete remediation exception configuration.

    • ResourceKeys — (Array<map>)

      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.

      • ResourceType — (String)

        The type of a resource.

      • ResourceId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FailedBatches — (Array<map>)

        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.

        • FailureMessage — (String)

          Returns a failure message for delete remediation exception. For example, Config creates an exception due to an internal error.

        • FailedItems — (Array<map>)

          Returns remediation exception resource key object of the failed items.

          • ResourceType — (String)

            The type of a resource.

          • ResourceId — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteResourceConfig(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteResourceConfig operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE' /* required */
};
configservice.deleteResourceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceType — (String)

      The type of the resource.

    • ResourceId — (String)

      Unique identifier of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRetentionConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the retention configuration.

Service Reference:

Examples:

Calling the deleteRetentionConfiguration operation

var params = {
  RetentionConfigurationName: 'STRING_VALUE' /* required */
};
configservice.deleteRetentionConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RetentionConfigurationName — (String)

      The name of the retention configuration to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteStoredQuery(params = {}, callback) ⇒ AWS.Request

Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.

Service Reference:

Examples:

Calling the deleteStoredQuery operation

var params = {
  QueryName: 'STRING_VALUE' /* required */
};
configservice.deleteStoredQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • QueryName — (String)

      The name of the query that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deliverConfigSnapshot(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deliverConfigSnapshot operation

var params = {
  deliveryChannelName: 'STRING_VALUE' /* required */
};
configservice.deliverConfigSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • deliveryChannelName — (String)

      The name of the delivery channel through which the snapshot is delivered.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • configSnapshotId — (String)

        The ID of the snapshot that is being created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAggregateComplianceByConfigRules(params = {}, callback) ⇒ AWS.Request

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.

Note: The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Service Reference:

Examples:

Calling the describeAggregateComplianceByConfigRules operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  Filters: {
    AccountId: 'STRING_VALUE',
    AwsRegion: 'STRING_VALUE',
    ComplianceType: COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA,
    ConfigRuleName: 'STRING_VALUE'
  },
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describeAggregateComplianceByConfigRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • Filters — (map)

      Filters the results by ConfigRuleComplianceFilters object.

      • ConfigRuleName — (String)

        The name of the Config rule.

      • ComplianceType — (String)

        The rule compliance status.

        For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.

        Possible values include:
        • "COMPLIANT"
        • "NON_COMPLIANT"
        • "NOT_APPLICABLE"
        • "INSUFFICIENT_DATA"
      • AccountId — (String)

        The 12-digit account ID of the source account.

      • AwsRegion — (String)

        The source region where the data is aggregated.

    • Limit — (Integer)

      The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AggregateComplianceByConfigRules — (Array<map>)

        Returns a list of AggregateComplianceByConfigRule object.

        • ConfigRuleName — (String)

          The name of the Config rule.

        • Compliance — (map)

          Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

          • ComplianceType — (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 only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

            Possible values include:
            • "COMPLIANT"
            • "NON_COMPLIANT"
            • "NOT_APPLICABLE"
            • "INSUFFICIENT_DATA"
          • ComplianceContributorCount — (map)

            The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

            • CappedCount — (Integer)

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

        • AccountId — (String)

          The 12-digit account ID of the source account.

        • AwsRegion — (String)

          The source region from where the data is aggregated.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAggregateComplianceByConformancePacks(params = {}, callback) ⇒ AWS.Request

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.

Note: The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Service Reference:

Examples:

Calling the describeAggregateComplianceByConformancePacks operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  Filters: {
    AccountId: 'STRING_VALUE',
    AwsRegion: 'STRING_VALUE',
    ComplianceType: COMPLIANT | NON_COMPLIANT | INSUFFICIENT_DATA,
    ConformancePackName: 'STRING_VALUE'
  },
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describeAggregateComplianceByConformancePacks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • Filters — (map)

      Filters the result by AggregateConformancePackComplianceFilters object.

      • ConformancePackName — (String)

        The name of the conformance pack.

      • ComplianceType — (String)

        The compliance status of the conformance pack.

        Possible values include:
        • "COMPLIANT"
        • "NON_COMPLIANT"
        • "INSUFFICIENT_DATA"
      • AccountId — (String)

        The 12-digit Amazon Web Services account ID of the source account.

      • AwsRegion — (String)

        The source Amazon Web Services Region from where the data is aggregated.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AggregateComplianceByConformancePacks — (Array<map>)

        Returns the AggregateComplianceByConformancePack object.

        • ConformancePackName — (String)

          The name of the conformance pack.

        • Compliance — (map)

          The compliance status of the conformance pack.

          • ComplianceType — (String)

            The compliance status of the conformance pack.

            Possible values include:
            • "COMPLIANT"
            • "NON_COMPLIANT"
            • "INSUFFICIENT_DATA"
          • CompliantRuleCount — (Integer)

            The number of compliant Config Rules.

          • NonCompliantRuleCount — (Integer)

            The number of noncompliant Config Rules.

          • TotalRuleCount — (Integer)

            Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

        • AccountId — (String)

          The 12-digit Amazon Web Services account ID of the source account.

        • AwsRegion — (String)

          The source Amazon Web Services Region from where the data is aggregated.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAggregationAuthorizations(params = {}, callback) ⇒ AWS.Request

Returns a list of authorizations granted to various aggregator accounts and regions.

Service Reference:

Examples:

Calling the describeAggregationAuthorizations operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describeAggregationAuthorizations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Limit — (Integer)

      The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AggregationAuthorizations — (Array<map>)

        Returns a list of authorizations granted to various aggregator accounts and regions.

        • AggregationAuthorizationArn — (String)

          The Amazon Resource Name (ARN) of the aggregation object.

        • AuthorizedAccountId — (String)

          The 12-digit account ID of the account authorized to aggregate data.

        • AuthorizedAwsRegion — (String)

          The region authorized to collect aggregated data.

        • CreationTime — (Date)

          The time stamp when the aggregation authorization was created.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeComplianceByConfigRule(params = {}, callback) ⇒ AWS.Request

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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • 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 the config: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.

Service Reference:

Examples:

Calling the describeComplianceByConfigRule operation

var params = {
  ComplianceTypes: [
    COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA,
    /* more items */
  ],
  ConfigRuleNames: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
configservice.describeComplianceByConfigRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleNames — (Array<String>)

      Specify one or more Config rule names to filter the results by rule.

    • ComplianceTypes — (Array<String>)

      Filters the results by compliance.

      The allowed values are COMPLIANT and NON_COMPLIANT.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ComplianceByConfigRules — (Array<map>)

        Indicates whether each of the specified Config rules is compliant.

        • ConfigRuleName — (String)

          The name of the Config rule.

        • Compliance — (map)

          Indicates whether the Config rule is compliant.

          • ComplianceType — (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 only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

            Possible values include:
            • "COMPLIANT"
            • "NON_COMPLIANT"
            • "NOT_APPLICABLE"
            • "INSUFFICIENT_DATA"
          • ComplianceContributorCount — (map)

            The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

            • CappedCount — (Integer)

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeComplianceByResource(params = {}, callback) ⇒ AWS.Request

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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • 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 the config: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.

Service Reference:

Examples:

Calling the describeComplianceByResource operation

var params = {
  ComplianceTypes: [
    COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA,
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceId: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
configservice.describeComplianceByResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceType — (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 specifying AWS::::Account.

    • ResourceId — (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.

    • ComplianceTypes — (Array<String>)

      Filters the results by compliance.

      The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ComplianceByResources — (Array<map>)

        Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.

        • ResourceType — (String)

          The type of the Amazon Web Services resource that was evaluated.

        • ResourceId — (String)

          The ID of the Amazon Web Services resource that was evaluated.

        • Compliance — (map)

          Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.

          • ComplianceType — (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 only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

            Possible values include:
            • "COMPLIANT"
            • "NON_COMPLIANT"
            • "NOT_APPLICABLE"
            • "INSUFFICIENT_DATA"
          • ComplianceContributorCount — (map)

            The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

            • CappedCount — (Integer)

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigRuleEvaluationStatus(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeConfigRuleEvaluationStatus operation

var params = {
  ConfigRuleNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describeConfigRuleEvaluationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleNames — (Array<String>)

      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.

    • NextToken — (String)

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

    • Limit — (Integer)

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

      For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigRulesEvaluationStatus — (Array<map>)

        Status information about your Config managed rules.

        • ConfigRuleName — (String)

          The name of the Config rule.

        • ConfigRuleArn — (String)

          The Amazon Resource Name (ARN) of the Config rule.

        • ConfigRuleId — (String)

          The ID of the Config rule.

        • LastSuccessfulInvocationTime — (Date)

          The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.

        • LastFailedInvocationTime — (Date)

          The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.

        • LastSuccessfulEvaluationTime — (Date)

          The time that Config last successfully evaluated your Amazon Web Services resources against the rule.

        • LastFailedEvaluationTime — (Date)

          The time that Config last failed to evaluate your Amazon Web Services resources against the rule.

        • FirstActivatedTime — (Date)

          The time that you first activated the Config rule.

        • LastDeactivatedTime — (Date)

          The time that you last turned off the Config rule.

        • LastErrorCode — (String)

          The error code that Config returned when the rule last failed.

        • LastErrorMessage — (String)

          The error message that Config returned when the rule last failed.

        • FirstEvaluationStarted — (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 once finished evaluating your Amazon Web Services resources against the rule.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigRules(params = {}, callback) ⇒ AWS.Request

Returns details about your Config rules.

Service Reference:

Examples:

Calling the describeConfigRules operation

var params = {
  ConfigRuleNames: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
configservice.describeConfigRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleNames — (Array<String>)

      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.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigRules — (Array<map>)

        The details about your Config rules.

        • ConfigRuleName — (String)

          The name that you assign to the Config rule. The name is required if you are adding a new rule.

        • ConfigRuleArn — (String)

          The Amazon Resource Name (ARN) of the Config rule.

        • ConfigRuleId — (String)

          The ID of the Config rule.

        • Description — (String)

          The description that you provide for the Config rule.

        • Scope — (map)

          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.

          Note: The scope can be empty.
          • ComplianceResourceTypes — (Array<String>)

            The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

          • TagKey — (String)

            The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

          • TagValue — (String)

            The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

          • ComplianceResourceId — (String)

            The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

        • Source — required — (map)

          Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

          • Owner — required — (String)

            Indicates whether Amazon Web Services or the customer owns and manages the Config rule.

            Possible values include:
            • "CUSTOM_LAMBDA"
            • "AWS"
          • SourceIdentifier — required — (String)

            For Config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

            For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.

          • SourceDetails — (Array<map>)

            Provides the source and type of the event that causes Config to evaluate your Amazon Web Services resources.

            • EventSource — (String)

              The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

              Possible values include:
              • "aws.config"
            • MessageType — (String)

              The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

              • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

              • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

              • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

              • ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a configuration snapshot.

              If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

              Possible values include:
              • "ConfigurationItemChangeNotification"
              • "ConfigurationSnapshotDeliveryCompleted"
              • "ScheduledNotification"
              • "OversizedConfigurationItemChangeNotification"
            • MaximumExecutionFrequency — (String)

              The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

              Note: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter. Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.
              Possible values include:
              • "One_Hour"
              • "Three_Hours"
              • "Six_Hours"
              • "Twelve_Hours"
              • "TwentyFour_Hours"
        • InputParameters — (String)

          A string, in JSON format, that is passed to the Config rule Lambda function.

        • MaximumExecutionFrequency — (String)

          The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

          • You are using 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.

          Note: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
          Possible values include:
          • "One_Hour"
          • "Three_Hours"
          • "Six_Hours"
          • "Twelve_Hours"
          • "TwentyFour_Hours"
        • ConfigRuleState — (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 the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

          Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.

          Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

          Possible values include:
          • "ACTIVE"
          • "DELETING"
          • "DELETING_RESULTS"
          • "EVALUATING"
        • CreatedBy — (String)

          Service principal name of the service that created the rule.

          Note: 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.
      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigurationAggregators(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeConfigurationAggregators operation

var params = {
  ConfigurationAggregatorNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describeConfigurationAggregators(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorNames — (Array<String>)

      The name of the configuration aggregators.

    • NextToken — (String)

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

    • Limit — (Integer)

      The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationAggregators — (Array<map>)

        Returns a ConfigurationAggregators object.

        • ConfigurationAggregatorName — (String)

          The name of the aggregator.

        • ConfigurationAggregatorArn — (String)

          The Amazon Resource Name (ARN) of the aggregator.

        • AccountAggregationSources — (Array<map>)

          Provides a list of source accounts and regions to be aggregated.

          • AccountIds — required — (Array<String>)

            The 12-digit account ID of the account being aggregated.

          • AllAwsRegions — (Boolean)

            If true, aggregate existing Config regions and future regions.

          • AwsRegions — (Array<String>)

            The source regions being aggregated.

        • OrganizationAggregationSource — (map)

          Provides an organization and list of regions to be aggregated.

          • RoleArn — required — (String)

            ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.

          • AwsRegions — (Array<String>)

            The source regions being aggregated.

          • AllAwsRegions — (Boolean)

            If true, aggregate existing Config regions and future regions.

        • CreationTime — (Date)

          The time stamp when the configuration aggregator was created.

        • LastUpdatedTime — (Date)

          The time of the last update.

        • CreatedBy — (String)

          Amazon Web Services service that created the configuration aggregator.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigurationAggregatorSourcesStatus(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeConfigurationAggregatorSourcesStatus operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  UpdateStatus: [
    FAILED | SUCCEEDED | OUTDATED,
    /* more items */
  ]
};
configservice.describeConfigurationAggregatorSourcesStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • UpdateStatus — (Array<String>)

      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.

    • NextToken — (String)

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

    • Limit — (Integer)

      The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AggregatedSourceStatusList — (Array<map>)

        Returns an AggregatedSourceStatus object.

        • SourceId — (String)

          The source account ID or an organization.

        • SourceType — (String)

          The source account or an organization.

          Possible values include:
          • "ACCOUNT"
          • "ORGANIZATION"
        • AwsRegion — (String)

          The region authorized to collect aggregated data.

        • LastUpdateStatus — (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.

          Possible values include:
          • "FAILED"
          • "SUCCEEDED"
          • "OUTDATED"
        • LastUpdateTime — (Date)

          The time of the last update.

        • LastErrorCode — (String)

          The error code that Config returned when the source account aggregation last failed.

        • LastErrorMessage — (String)

          The message indicating that the source account aggregation failed due to an error.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigurationRecorders(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

Calling the describeConfigurationRecorders operation

var params = {
  ConfigurationRecorderNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeConfigurationRecorders(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationRecorderNames — (Array<String>)

      A list of configuration recorder names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationRecorders — (Array<map>)

        A list that contains the descriptions of the specified configuration recorders.

        • name — (String)

          The name of the recorder. By default, Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.

        • roleARN — (String)

          Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.

        • recordingGroup — (map)

          Specifies the types of Amazon Web Services resources for which Config records configuration changes.

          • allSupported — (Boolean)

            Specifies whether Config records configuration changes for every supported type of regional resource.

            If you set this option to true, when Config adds support for a new type of regional resource, it starts recording resources of that type automatically.

            If you set this option to true, you cannot enumerate a list of resourceTypes.

          • includeGlobalResourceTypes — (Boolean)

            Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

            Before you can set this option to true, you must set the allSupported option to true.

            If you set this option to true, when Config adds support for a new type of global resource, it starts recording resources of that type automatically.

            The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.

          • resourceTypes — (Array<String>)

            A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

            To record all configuration changes, you must set the allSupported option to true.

            If you set this option to false, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

            For a list of valid resourceTypes values, see the resourceType Value column in Supported Amazon Web Services resource Types.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigurationRecorderStatus(params = {}, callback) ⇒ AWS.Request

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.

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

Service Reference:

Examples:

Calling the describeConfigurationRecorderStatus operation

var params = {
  ConfigurationRecorderNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeConfigurationRecorderStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationRecorderNames — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationRecordersStatus — (Array<map>)

        A list that contains status of the specified recorders.

        • name — (String)

          The name of the configuration recorder.

        • lastStartTime — (Date)

          The time the recorder was last started.

        • lastStopTime — (Date)

          The time the recorder was last stopped.

        • recording — (Boolean)

          Specifies whether or not the recorder is currently recording.

        • lastStatus — (String)

          The last (previous) status of the recorder.

          Possible values include:
          • "Pending"
          • "Success"
          • "Failure"
        • lastErrorCode — (String)

          The error code indicating that the recording failed.

        • lastErrorMessage — (String)

          The message indicating that the recording failed due to an error.

        • lastStatusChangeTime — (Date)

          The time when the status was last changed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConformancePackCompliance(params = {}, callback) ⇒ AWS.Request

Returns compliance details for each rule in that conformance pack.

Note: You must provide exact rule names.

Service Reference:

Examples:

Calling the describeConformancePackCompliance operation

var params = {
  ConformancePackName: 'STRING_VALUE', /* required */
  Filters: {
    ComplianceType: COMPLIANT | NON_COMPLIANT | INSUFFICIENT_DATA,
    ConfigRuleNames: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describeConformancePackCompliance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConformancePackName — (String)

      Name of the conformance pack.

    • Filters — (map)

      A ConformancePackComplianceFilters object.

      • ConfigRuleNames — (Array<String>)

        Filters the results by Config rule names.

      • ComplianceType — (String)

        Filters the results by compliance.

        The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

        Possible values include:
        • "COMPLIANT"
        • "NON_COMPLIANT"
        • "INSUFFICIENT_DATA"
    • Limit — (Integer)

      The maximum number of Config rules within a conformance pack are returned on each page.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConformancePackName — (String)

        Name of the conformance pack.

      • ConformancePackRuleComplianceList — (Array<map>)

        Returns a list of ConformancePackRuleCompliance objects.

        • ConfigRuleName — (String)

          Name of the config rule.

        • ComplianceType — (String)

          Compliance of the Config rule.

          The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
          • "INSUFFICIENT_DATA"
        • Controls — (Array<String>)

          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.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConformancePacks(params = {}, callback) ⇒ AWS.Request

Returns a list of one or more conformance packs.

Service Reference:

Examples:

Calling the describeConformancePacks operation

var params = {
  ConformancePackNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describeConformancePacks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConformancePackNames — (Array<String>)

      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 — (Integer)

      The maximum number of conformance packs returned on each page.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConformancePackDetails — (Array<map>)

        Returns a list of ConformancePackDetail objects.

        • ConformancePackName — required — (String)

          Name of the conformance pack.

        • ConformancePackArn — required — (String)

          Amazon Resource Name (ARN) of the conformance pack.

        • ConformancePackId — required — (String)

          ID of the conformance pack.

        • DeliveryS3Bucket — (String)

          The name of the Amazon S3 bucket where Config stores conformance pack templates.

          Note: This field is optional.
        • DeliveryS3KeyPrefix — (String)

          The prefix for the Amazon S3 bucket.

          Note: This field is optional.
        • ConformancePackInputParameters — (Array<map>)

          A list of ConformancePackInputParameter objects.

          • ParameterName — required — (String)

            One part of a key-value pair.

          • ParameterValue — required — (String)

            Another part of the key-value pair.

        • LastUpdateRequestedTime — (Date)

          Last time when conformation pack update was requested.

        • CreatedBy — (String)

          Amazon Web Services service that created the conformance pack.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConformancePackStatus(params = {}, callback) ⇒ AWS.Request

Provides one or more conformance packs deployment status.

Note: If there are no conformance packs then you will see an empty result.

Service Reference:

Examples:

Calling the describeConformancePackStatus operation

var params = {
  ConformancePackNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describeConformancePackStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConformancePackNames — (Array<String>)

      Comma-separated list of conformance pack names.

    • Limit — (Integer)

      The maximum number of conformance packs status returned on each page.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConformancePackStatusDetails — (Array<map>)

        A list of ConformancePackStatusDetail objects.

        • ConformancePackName — required — (String)

          Name of the conformance pack.

        • ConformancePackId — required — (String)

          ID of the conformance pack.

        • ConformancePackArn — required — (String)

          Amazon Resource Name (ARN) of comformance pack.

        • ConformancePackState — required — (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.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_COMPLETE"
          • "CREATE_FAILED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
        • StackArn — required — (String)

          Amazon Resource Name (ARN) of CloudFormation stack.

        • ConformancePackStatusReason — (String)

          The reason of conformance pack creation failure.

        • LastUpdateRequestedTime — required — (Date)

          Last time when conformation pack creation and update was requested.

        • LastUpdateCompletedTime — (Date)

          Last time when conformation pack creation and update was successful.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDeliveryChannels(params = {}, callback) ⇒ AWS.Request

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.

Note: Currently, you can specify only one delivery channel per region in your account.

Service Reference:

Examples:

Calling the describeDeliveryChannels operation

var params = {
  DeliveryChannelNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeDeliveryChannels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeliveryChannelNames — (Array<String>)

      A list of delivery channel names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeliveryChannels — (Array<map>)

        A list that contains the descriptions of the specified delivery channel.

        • name — (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 — (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 — (String)

          The prefix for the specified Amazon S3 bucket.

        • s3KmsKeyArn — (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 — (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.

        • configSnapshotDeliveryProperties — (map)

          The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

          • deliveryFrequency — (String)

            The frequency with which Config delivers configuration snapshots.

            Possible values include:
            • "One_Hour"
            • "Three_Hours"
            • "Six_Hours"
            • "Twelve_Hours"
            • "TwentyFour_Hours"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDeliveryChannelStatus(params = {}, callback) ⇒ AWS.Request

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.

Note: Currently, you can specify only one delivery channel per region in your account.

Service Reference:

Examples:

Calling the describeDeliveryChannelStatus operation

var params = {
  DeliveryChannelNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeDeliveryChannelStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeliveryChannelNames — (Array<String>)

      A list of delivery channel names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeliveryChannelsStatus — (Array<map>)

        A list that contains the status of a specified delivery channel.

        • name — (String)

          The name of the delivery channel.

        • configSnapshotDeliveryInfo — (map)

          A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.

          • lastStatus — (String)

            Status of the last attempted delivery.

            Possible values include:
            • "Success"
            • "Failure"
            • "Not_Applicable"
          • lastErrorCode — (String)

            The error code from the last attempted delivery.

          • lastErrorMessage — (String)

            The error message from the last attempted delivery.

          • lastAttemptTime — (Date)

            The time of the last attempted delivery.

          • lastSuccessfulTime — (Date)

            The time of the last successful delivery.

          • nextDeliveryTime — (Date)

            The time that the next delivery occurs.

        • configHistoryDeliveryInfo — (map)

          A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.

          • lastStatus — (String)

            Status of the last attempted delivery.

            Possible values include:
            • "Success"
            • "Failure"
            • "Not_Applicable"
          • lastErrorCode — (String)

            The error code from the last attempted delivery.

          • lastErrorMessage — (String)

            The error message from the last attempted delivery.

          • lastAttemptTime — (Date)

            The time of the last attempted delivery.

          • lastSuccessfulTime — (Date)

            The time of the last successful delivery.

          • nextDeliveryTime — (Date)

            The time that the next delivery occurs.

        • configStreamDeliveryInfo — (map)

          A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.

          • lastStatus — (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.

            Possible values include:
            • "Success"
            • "Failure"
            • "Not_Applicable"
          • lastErrorCode — (String)

            The error code from the last attempted delivery.

          • lastErrorMessage — (String)

            The error message from the last attempted delivery.

          • lastStatusChangeTime — (Date)

            The time from the last status change.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeOrganizationConfigRules(params = {}, callback) ⇒ AWS.Request

Returns a list of organization config rules.

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

Service Reference:

Examples:

Calling the describeOrganizationConfigRules operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OrganizationConfigRuleNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeOrganizationConfigRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConfigRuleNames — (Array<String>)

      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.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationConfigRules — (Array<map>)

        Returns a list of OrganizationConfigRule objects.

        • OrganizationConfigRuleName — required — (String)

          The name that you assign to organization config rule.

        • OrganizationConfigRuleArn — required — (String)

          Amazon Resource Name (ARN) of organization config rule.

        • OrganizationManagedRuleMetadata — (map)

          An OrganizationManagedRuleMetadata object.

          • Description — (String)

            The description that you provide for organization config rule.

          • RuleIdentifier — required — (String)

            For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

          • InputParameters — (String)

            A string, in JSON format, that is passed to organization config rule Lambda function.

          • MaximumExecutionFrequency — (String)

            The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.

            Note: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
            Possible values include:
            • "One_Hour"
            • "Three_Hours"
            • "Six_Hours"
            • "Twelve_Hours"
            • "TwentyFour_Hours"
          • ResourceTypesScope — (Array<String>)

            The type of the Amazon Web Services resource that was evaluated.

          • ResourceIdScope — (String)

            The ID of the Amazon Web Services resource that was evaluated.

          • TagKeyScope — (String)

            One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

          • TagValueScope — (String)

            The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

        • OrganizationCustomRuleMetadata — (map)

          An OrganizationCustomRuleMetadata object.

          • Description — (String)

            The description that you provide for organization config rule.

          • LambdaFunctionArn — required — (String)

            The lambda function ARN.

          • OrganizationConfigRuleTriggerTypes — required — (Array<String>)

            The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

            • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

            • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

            • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

          • InputParameters — (String)

            A string, in JSON format, that is passed to organization config rule Lambda function.

          • MaximumExecutionFrequency — (String)

            The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

            Note: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
            Possible values include:
            • "One_Hour"
            • "Three_Hours"
            • "Six_Hours"
            • "Twelve_Hours"
            • "TwentyFour_Hours"
          • ResourceTypesScope — (Array<String>)

            The type of the Amazon Web Services resource that was evaluated.

          • ResourceIdScope — (String)

            The ID of the Amazon Web Services resource that was evaluated.

          • TagKeyScope — (String)

            One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

          • TagValueScope — (String)

            The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

        • ExcludedAccounts — (Array<String>)

          A comma-separated list of accounts excluded from organization config rule.

        • LastUpdateTime — (Date)

          The timestamp of the last update.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeOrganizationConfigRuleStatuses(params = {}, callback) ⇒ AWS.Request

Provides organization config rule deployment status for an organization.

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

Service Reference:

Examples:

Calling the describeOrganizationConfigRuleStatuses operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OrganizationConfigRuleNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeOrganizationConfigRuleStatuses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConfigRuleNames — (Array<String>)

      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.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationConfigRuleStatuses — (Array<map>)

        A list of OrganizationConfigRuleStatus objects.

        • OrganizationConfigRuleName — required — (String)

          The name that you assign to organization config rule.

        • OrganizationRuleStatus — required — (String)

          Indicates deployment status of an organization config rule. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in all the member accounts. Additionally, config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

          Config sets the state of the rule to:

          • CREATE_SUCCESSFUL when an organization config rule has been successfully created in all the member accounts.

          • CREATE_IN_PROGRESS when an organization config rule creation is in progress.

          • CREATE_FAILED when an organization config rule creation failed in one or more member accounts within that organization.

          • DELETE_FAILED when an organization config rule deletion failed in one or more member accounts within that organization.

          • DELETE_IN_PROGRESS when an organization config rule deletion is in progress.

          • DELETE_SUCCESSFUL when an organization config rule has been successfully deleted from all the member accounts.

          • UPDATE_SUCCESSFUL when an organization config rule has been successfully updated in all the member accounts.

          • UPDATE_IN_PROGRESS when an organization config rule update is in progress.

          • UPDATE_FAILED when an organization config rule update failed in one or more member accounts within that organization.

          Possible values include:
          • "CREATE_SUCCESSFUL"
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "DELETE_SUCCESSFUL"
          • "DELETE_FAILED"
          • "DELETE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
        • ErrorCode — (String)

          An error code that is returned when organization config rule creation or deletion has failed.

        • ErrorMessage — (String)

          An error message indicating that organization config rule creation or deletion failed due to an error.

        • LastUpdateTime — (Date)

          The timestamp of the last update.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeOrganizationConformancePacks(params = {}, callback) ⇒ AWS.Request

Returns a list of organization conformance packs.

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

Service Reference:

Examples:

Calling the describeOrganizationConformancePacks operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OrganizationConformancePackNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeOrganizationConformancePacks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConformancePackNames — (Array<String>)

      The name that you assign to an organization conformance pack.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationConformancePacks — (Array<map>)

        Returns a list of OrganizationConformancePacks objects.

        • OrganizationConformancePackName — required — (String)

          The name you assign to an organization conformance pack.

        • OrganizationConformancePackArn — required — (String)

          Amazon Resource Name (ARN) of organization conformance pack.

        • DeliveryS3Bucket — (String)

          The name of the Amazon S3 bucket where Config stores conformance pack templates.

          Note: This field is optional.
        • DeliveryS3KeyPrefix — (String)

          Any folder structure you want to add to an Amazon S3 bucket.

          Note: This field is optional.
        • ConformancePackInputParameters — (Array<map>)

          A list of ConformancePackInputParameter objects.

          • ParameterName — required — (String)

            One part of a key-value pair.

          • ParameterValue — required — (String)

            Another part of the key-value pair.

        • ExcludedAccounts — (Array<String>)

          A comma-separated list of accounts excluded from organization conformance pack.

        • LastUpdateTime — required — (Date)

          Last time when organization conformation pack was updated.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeOrganizationConformancePackStatuses(params = {}, callback) ⇒ AWS.Request

Provides organization conformance pack deployment status for an organization.

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

Service Reference:

Examples:

Calling the describeOrganizationConformancePackStatuses operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OrganizationConformancePackNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeOrganizationConformancePackStatuses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConformancePackNames — (Array<String>)

      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.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationConformancePackStatuses — (Array<map>)

        A list of OrganizationConformancePackStatus objects.

        • OrganizationConformancePackName — required — (String)

          The name that you assign to organization conformance pack.

        • Status — required — (String)

          Indicates deployment status of an organization conformance pack. When master account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When master account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the master account deletes OrganizationConformancePack in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

          Config sets the state of the conformance pack to:

          • CREATE_SUCCESSFUL when an organization conformance pack has been successfully created in all the member accounts.

          • CREATE_IN_PROGRESS when an organization conformance pack creation is in progress.

          • CREATE_FAILED when an organization conformance pack creation failed in one or more member accounts within that organization.

          • DELETE_FAILED when an organization conformance pack deletion failed in one or more member accounts within that organization.

          • DELETE_IN_PROGRESS when an organization conformance pack deletion is in progress.

          • DELETE_SUCCESSFUL when an organization conformance pack has been successfully deleted from all the member accounts.

          • UPDATE_SUCCESSFUL when an organization conformance pack has been successfully updated in all the member accounts.

          • UPDATE_IN_PROGRESS when an organization conformance pack update is in progress.

          • UPDATE_FAILED when an organization conformance pack update failed in one or more member accounts within that organization.

          Possible values include:
          • "CREATE_SUCCESSFUL"
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "DELETE_SUCCESSFUL"
          • "DELETE_FAILED"
          • "DELETE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
        • ErrorCode — (String)

          An error code that is returned when organization conformance pack creation or deletion has failed in a member account.

        • ErrorMessage — (String)

          An error message indicating that organization conformance pack creation or deletion failed due to an error.

        • LastUpdateTime — (Date)

          The timestamp of the last update.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePendingAggregationRequests(params = {}, callback) ⇒ AWS.Request

Returns a list of all pending aggregation requests.

Service Reference:

Examples:

Calling the describePendingAggregationRequests operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.describePendingAggregationRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Limit — (Integer)

      The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PendingAggregationRequests — (Array<map>)

        Returns a PendingAggregationRequests object.

        • RequesterAccountId — (String)

          The 12-digit account ID of the account requesting to aggregate data.

        • RequesterAwsRegion — (String)

          The region requesting to aggregate data.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRemediationConfigurations(params = {}, callback) ⇒ AWS.Request

Returns the details of one or more remediation configurations.

Service Reference:

Examples:

Calling the describeRemediationConfigurations operation

var params = {
  ConfigRuleNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeRemediationConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleNames — (Array<String>)

      A list of Config rule names of remediation configurations for which you want details.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RemediationConfigurations — (Array<map>)

        Returns a remediation configuration object.

        • ConfigRuleName — required — (String)

          The name of the Config rule.

        • TargetType — required — (String)

          The type of the target. Target executes remediation. For example, SSM document.

          Possible values include:
          • "SSM_DOCUMENT"
        • TargetId — required — (String)

          Target ID is the name of the public document.

        • TargetVersion — (String)

          Version of the target. For example, version of the SSM document.

          Note: If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
        • Parameters — (map<map>)

          An object of the RemediationParameterValue.

          • ResourceValue — (map)

            The value is dynamic and changes at run-time.

            • Value — required — (String)

              The value is a resource ID.

              Possible values include:
              • "RESOURCE_ID"
          • StaticValue — (map)

            The value is static and does not change at run-time.

            • Values — required — (Array<String>)

              A list of values. For example, the ARN of the assumed role.

        • ResourceType — (String)

          The type of a resource.

        • Automatic — (Boolean)

          The remediation is triggered automatically.

        • ExecutionControls — (map)

          An ExecutionControls object.

          • SsmControls — (map)

            A SsmControls object.

            • ConcurrentExecutionRatePercentage — (Integer)

              The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.

            • ErrorPercentage — (Integer)

              The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

        • MaximumAutomaticAttempts — (Integer)

          The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

          For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

        • RetryAttemptSeconds — (Integer)

          Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

          For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

        • Arn — (String)

          Amazon Resource Name (ARN) of remediation configuration.

        • CreatedByService — (String)

          Name of the service that owns the service linked rule, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRemediationExceptions(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the describeRemediationExceptions operation

var params = {
  ConfigRuleName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceKeys: [
    {
      ResourceId: 'STRING_VALUE',
      ResourceType: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.describeRemediationExceptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The name of the Config rule.

    • ResourceKeys — (Array<map>)

      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.

      • ResourceType — (String)

        The type of a resource.

      • ResourceId — (String)

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

    • Limit — (Integer)

      The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RemediationExceptions — (Array<map>)

        Returns a list of remediation exception objects.

        • ConfigRuleName — required — (String)

          The name of the Config rule.

        • ResourceType — required — (String)

          The type of a resource.

        • ResourceId — required — (String)

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

        • Message — (String)

          An explanation of an remediation exception.

        • ExpirationTime — (Date)

          The time when the remediation exception will be deleted.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRemediationExecutionStatus(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeRemediationExecutionStatus operation

var params = {
  ConfigRuleName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceKeys: [
    {
      resourceId: 'STRING_VALUE', /* 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 /* required */
    },
    /* more items */
  ]
};
configservice.describeRemediationExecutionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      A list of Config rule names.

    • ResourceKeys — (Array<map>)

      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.

      • resourceType — required — (String)

        The resource type.

        Possible values include:
        • "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"
      • resourceId — required — (String)

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

    • Limit — (Integer)

      The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RemediationExecutionStatuses — (Array<map>)

        Returns a list of remediation execution statuses objects.

        • ResourceKey — (map)

          The details that identify a resource within Config, including the resource type and resource ID.

          • resourceType — required — (String)

            The resource type.

            Possible values include:
            • "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"
          • resourceId — required — (String)

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

        • State — (String)

          ENUM of the values.

          Possible values include:
          • "QUEUED"
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
        • StepDetails — (Array<map>)

          Details of every step.

          • Name — (String)

            The details of the step.

          • State — (String)

            The valid status of the step.

            Possible values include:
            • "SUCCEEDED"
            • "PENDING"
            • "FAILED"
          • ErrorMessage — (String)

            An error message if the step was interrupted during execution.

          • StartTime — (Date)

            The time when the step started.

          • StopTime — (Date)

            The time when the step stopped.

        • InvocationTime — (Date)

          Start time when the remediation was executed.

        • LastUpdatedTime — (Date)

          The time when the remediation execution was last updated.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRetentionConfigurations(params = {}, callback) ⇒ AWS.Request

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.

Note: Currently, Config supports only one retention configuration per region in your account.

Service Reference:

Examples:

Calling the describeRetentionConfigurations operation

var params = {
  NextToken: 'STRING_VALUE',
  RetentionConfigurationNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.describeRetentionConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RetentionConfigurationNames — (Array<String>)

      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.

      Note: Currently, Config supports only one retention configuration per region in your account.
    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RetentionConfigurations — (Array<map>)

        Returns a retention configuration object.

        • Name — required — (String)

          The name of the retention configuration object.

        • RetentionPeriodInDays — required — (Integer)

          Number of days Config stores your historical information.

          Note: Currently, only applicable to the configuration item history.
      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAggregateComplianceDetailsByConfigRule(params = {}, callback) ⇒ AWS.Request

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.

Note: The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

Service Reference:

Examples:

Calling the getAggregateComplianceDetailsByConfigRule operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  AwsRegion: 'STRING_VALUE', /* required */
  ConfigRuleName: 'STRING_VALUE', /* required */
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  ComplianceType: COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA,
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getAggregateComplianceDetailsByConfigRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • ConfigRuleName — (String)

      The name of the Config rule for which you want compliance information.

    • AccountId — (String)

      The 12-digit account ID of the source account.

    • AwsRegion — (String)

      The source region from where the data is aggregated.

    • ComplianceType — (String)

      The resource compliance status.

      Note: For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.
      Possible values include:
      • "COMPLIANT"
      • "NON_COMPLIANT"
      • "NOT_APPLICABLE"
      • "INSUFFICIENT_DATA"
    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AggregateEvaluationResults — (Array<map>)

        Returns an AggregateEvaluationResults object.

        • EvaluationResultIdentifier — (map)

          Uniquely identifies the evaluation result.

          • EvaluationResultQualifier — (map)

            Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

            • ConfigRuleName — (String)

              The name of the Config rule that was used in the evaluation.

            • ResourceType — (String)

              The type of Amazon Web Services resource that was evaluated.

            • ResourceId — (String)

              The ID of the evaluated Amazon Web Services resource.

          • OrderingTimestamp — (Date)

            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.

        • ComplianceType — (String)

          The resource compliance status.

          For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
          • "NOT_APPLICABLE"
          • "INSUFFICIENT_DATA"
        • ResultRecordedTime — (Date)

          The time when Config recorded the aggregate evaluation result.

        • ConfigRuleInvokedTime — (Date)

          The time when the Config rule evaluated the Amazon Web Services resource.

        • Annotation — (String)

          Supplementary information about how the agrregate evaluation determined the compliance.

        • AccountId — (String)

          The 12-digit account ID of the source account.

        • AwsRegion — (String)

          The source region from where the data is aggregated.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAggregateConfigRuleComplianceSummary(params = {}, callback) ⇒ AWS.Request

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

Note: The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Service Reference:

Examples:

Calling the getAggregateConfigRuleComplianceSummary operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  Filters: {
    AccountId: 'STRING_VALUE',
    AwsRegion: 'STRING_VALUE'
  },
  GroupByKey: ACCOUNT_ID | AWS_REGION,
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getAggregateConfigRuleComplianceSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • Filters — (map)

      Filters the results based on the ConfigRuleComplianceSummaryFilters object.

      • AccountId — (String)

        The 12-digit account ID of the source account.

      • AwsRegion — (String)

        The source region where the data is aggregated.

    • GroupByKey — (String)

      Groups the result based on ACCOUNT_ID or AWS_REGION.

      Possible values include:
      • "ACCOUNT_ID"
      • "AWS_REGION"
    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GroupByKey — (String)

        Groups the result based on ACCOUNT_ID or AWS_REGION.

      • AggregateComplianceCounts — (Array<map>)

        Returns a list of AggregateComplianceCounts object.

        • GroupName — (String)

          The 12-digit account ID or region based on the GroupByKey value.

        • ComplianceSummary — (map)

          The number of compliant and noncompliant Config rules.

          • CompliantResourceCount — (map)

            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.

            • CappedCount — (Integer)

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

          • NonCompliantResourceCount — (map)

            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.

            • CappedCount — (Integer)

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

          • ComplianceSummaryTimestamp — (Date)

            The time that Config created the compliance summary.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAggregateConformancePackComplianceSummary(params = {}, callback) ⇒ AWS.Request

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.

Note: The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Service Reference:

Examples:

Calling the getAggregateConformancePackComplianceSummary operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  Filters: {
    AccountId: 'STRING_VALUE',
    AwsRegion: 'STRING_VALUE'
  },
  GroupByKey: ACCOUNT_ID | AWS_REGION,
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getAggregateConformancePackComplianceSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • Filters — (map)

      Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.

      • AccountId — (String)

        The 12-digit Amazon Web Services account ID of the source account.

      • AwsRegion — (String)

        The source Amazon Web Services Region from where the data is aggregated.

    • GroupByKey — (String)

      Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

      Possible values include:
      • "ACCOUNT_ID"
      • "AWS_REGION"
    • Limit — (Integer)

      The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AggregateConformancePackComplianceSummaries — (Array<map>)

        Returns a list of AggregateConformancePackComplianceSummary object.

        • ComplianceSummary — (map)

          Returns an AggregateConformancePackComplianceCount object.

          • CompliantConformancePackCount — (Integer)

            Number of compliant conformance packs.

          • NonCompliantConformancePackCount — (Integer)

            Number of noncompliant conformance packs.

        • GroupName — (String)

          Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

      • GroupByKey — (String)

        Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAggregateDiscoveredResourceCounts(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getAggregateDiscoveredResourceCounts operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  Filters: {
    AccountId: 'STRING_VALUE',
    Region: 'STRING_VALUE',
    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
  },
  GroupByKey: RESOURCE_TYPE | ACCOUNT_ID | AWS_REGION,
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getAggregateDiscoveredResourceCounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • Filters — (map)

      Filters the results based on the ResourceCountFilters object.

      • ResourceType — (String)

        The type of the Amazon Web Services resource.

        Possible values include:
        • "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"
      • AccountId — (String)

        The 12-digit ID of the account.

      • Region — (String)

        The region where the account is located.

    • GroupByKey — (String)

      The key to group the resource counts.

      Possible values include:
      • "RESOURCE_TYPE"
      • "ACCOUNT_ID"
      • "AWS_REGION"
    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TotalDiscoveredResources — (Integer)

        The total number of resources that are present in an aggregator with the filters that you provide.

      • GroupByKey — (String)

        The key passed into the request object. If GroupByKey is not provided, the result will be empty.

      • GroupedResourceCounts — (Array<map>)

        Returns a list of GroupedResourceCount objects.

        • GroupName — required — (String)

          The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey.

        • ResourceCount — required — (Integer)

          The number of resources in the group.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAggregateResourceConfig(params = {}, callback) ⇒ AWS.Request

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

Service Reference:

Examples:

Calling the getAggregateResourceConfig operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  ResourceIdentifier: { /* required */
    ResourceId: 'STRING_VALUE', /* 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, /* required */
    SourceAccountId: 'STRING_VALUE', /* required */
    SourceRegion: 'STRING_VALUE', /* required */
    ResourceName: 'STRING_VALUE'
  }
};
configservice.getAggregateResourceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • ResourceIdentifier — (map)

      An object that identifies aggregate resource.

      • SourceAccountId — required — (String)

        The 12-digit account ID of the source account.

      • SourceRegion — required — (String)

        The source region where data is aggregated.

      • ResourceId — required — (String)

        The ID of the Amazon Web Services resource.

      • ResourceType — required — (String)

        The type of the Amazon Web Services resource.

        Possible values include:
        • "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"
      • ResourceName — (String)

        The name of the Amazon Web Services resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationItem — (map)

        Returns a ConfigurationItem object.

        • version — (String)

          The version number of the resource configuration.

        • accountId — (String)

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

        • configurationItemCaptureTime — (Date)

          The time when the configuration recording was initiated.

        • configurationItemStatus — (String)

          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

          Note: The CIs do not incur any cost.
          Possible values include:
          • "OK"
          • "ResourceDiscovered"
          • "ResourceNotRecorded"
          • "ResourceDeleted"
          • "ResourceDeletedNotRecorded"
        • configurationStateId — (String)

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

        • configurationItemMD5Hash — (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.

        • arn — (String)

          Amazon Resource Name (ARN) associated with the resource.

        • resourceType — (String)

          The type of Amazon Web Services resource.

          Possible values include:
          • "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"
        • resourceId — (String)

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

        • resourceName — (String)

          The custom name of the resource, if available.

        • awsRegion — (String)

          The region where the resource resides.

        • availabilityZone — (String)

          The Availability Zone associated with the resource.

        • resourceCreationTime — (Date)

          The time stamp when the resource was created.

        • tags — (map<String>)

          A mapping of key value tags associated with the resource.

        • relatedEvents — (Array<String>)

          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 — (Array<map>)

          A list of related Amazon Web Services resources.

          • resourceType — (String)

            The resource type of the related resource.

            Possible values include:
            • "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"
          • resourceId — (String)

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

          • resourceName — (String)

            The custom name of the related resource, if available.

          • relationshipName — (String)

            The type of relationship with the related resource.

        • configuration — (String)

          The description of the resource configuration.

        • supplementaryConfiguration — (map<String>)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getComplianceDetailsByConfigRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getComplianceDetailsByConfigRule operation

var params = {
  ConfigRuleName: 'STRING_VALUE', /* required */
  ComplianceTypes: [
    COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA,
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getComplianceDetailsByConfigRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The name of the Config rule for which you want compliance information.

    • ComplianceTypes — (Array<String>)

      Filters the results by compliance.

      The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EvaluationResults — (Array<map>)

        Indicates whether the Amazon Web Services resource complies with the specified Config rule.

        • EvaluationResultIdentifier — (map)

          Uniquely identifies the evaluation result.

          • EvaluationResultQualifier — (map)

            Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

            • ConfigRuleName — (String)

              The name of the Config rule that was used in the evaluation.

            • ResourceType — (String)

              The type of Amazon Web Services resource that was evaluated.

            • ResourceId — (String)

              The ID of the evaluated Amazon Web Services resource.

          • OrderingTimestamp — (Date)

            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.

        • ComplianceType — (String)

          Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

          For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
          • "NOT_APPLICABLE"
          • "INSUFFICIENT_DATA"
        • ResultRecordedTime — (Date)

          The time when Config recorded the evaluation result.

        • ConfigRuleInvokedTime — (Date)

          The time when the Config rule evaluated the Amazon Web Services resource.

        • Annotation — (String)

          Supplementary information about how the evaluation determined the compliance.

        • ResultToken — (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.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getComplianceDetailsByResource(params = {}, callback) ⇒ AWS.Request

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 used, and whether the resource complies with each rule.

Service Reference:

Examples:

Calling the getComplianceDetailsByResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE', /* required */
  ComplianceTypes: [
    COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA,
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
configservice.getComplianceDetailsByResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceType — (String)

      The type of the Amazon Web Services resource for which you want compliance information.

    • ResourceId — (String)

      The ID of the Amazon Web Services resource for which you want compliance information.

    • ComplianceTypes — (Array<String>)

      Filters the results by compliance.

      The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EvaluationResults — (Array<map>)

        Indicates whether the specified Amazon Web Services resource complies each Config rule.

        • EvaluationResultIdentifier — (map)

          Uniquely identifies the evaluation result.

          • EvaluationResultQualifier — (map)

            Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

            • ConfigRuleName — (String)

              The name of the Config rule that was used in the evaluation.

            • ResourceType — (String)

              The type of Amazon Web Services resource that was evaluated.

            • ResourceId — (String)

              The ID of the evaluated Amazon Web Services resource.

          • OrderingTimestamp — (Date)

            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.

        • ComplianceType — (String)

          Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

          For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
          • "NOT_APPLICABLE"
          • "INSUFFICIENT_DATA"
        • ResultRecordedTime — (Date)

          The time when Config recorded the evaluation result.

        • ConfigRuleInvokedTime — (Date)

          The time when the Config rule evaluated the Amazon Web Services resource.

        • Annotation — (String)

          Supplementary information about how the evaluation determined the compliance.

        • ResultToken — (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.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getComplianceSummaryByConfigRule(params = {}, callback) ⇒ AWS.Request

Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

Service Reference:

Examples:

Calling the getComplianceSummaryByConfigRule operation

configservice.getComplianceSummaryByConfigRule(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ComplianceSummary — (map)

        The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

        • CompliantResourceCount — (map)

          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.

          • CappedCount — (Integer)

            The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

          • CapExceeded — (Boolean)

            Indicates whether the maximum count is reached.

        • NonCompliantResourceCount — (map)

          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.

          • CappedCount — (Integer)

            The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

          • CapExceeded — (Boolean)

            Indicates whether the maximum count is reached.

        • ComplianceSummaryTimestamp — (Date)

          The time that Config created the compliance summary.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getComplianceSummaryByResourceType(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getComplianceSummaryByResourceType operation

var params = {
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.getComplianceSummaryByResourceType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceTypes — (Array<String>)

      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 specifying AWS::::Account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ComplianceSummariesByResourceType — (Array<map>)

        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.

        • ResourceType — (String)

          The type of Amazon Web Services resource.

        • ComplianceSummary — (map)

          The number of Amazon Web Services resources that are compliant or noncompliant, up to a maximum of 100 for each.

          • CompliantResourceCount — (map)

            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.

            • CappedCount — (Integer)

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

          • NonCompliantResourceCount — (map)

            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.

            • CappedCount — (Integer)

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

          • ComplianceSummaryTimestamp — (Date)

            The time that Config created the compliance summary.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getConformancePackComplianceDetails(params = {}, callback) ⇒ AWS.Request

Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.

Service Reference:

Examples:

Calling the getConformancePackComplianceDetails operation

var params = {
  ConformancePackName: 'STRING_VALUE', /* required */
  Filters: {
    ComplianceType: COMPLIANT | NON_COMPLIANT | INSUFFICIENT_DATA,
    ConfigRuleNames: [
      'STRING_VALUE',
      /* more items */
    ],
    ResourceIds: [
      'STRING_VALUE',
      /* more items */
    ],
    ResourceType: 'STRING_VALUE'
  },
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getConformancePackComplianceDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConformancePackName — (String)

      Name of the conformance pack.

    • Filters — (map)

      A ConformancePackEvaluationFilters object.

      • ConfigRuleNames — (Array<String>)

        Filters the results by Config rule names.

      • ComplianceType — (String)

        Filters the results by compliance.

        The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

        Possible values include:
        • "COMPLIANT"
        • "NON_COMPLIANT"
        • "INSUFFICIENT_DATA"
      • ResourceType — (String)

        Filters the results by the resource type (for example, "AWS::EC2::Instance").

      • ResourceIds — (Array<String>)

        Filters the results by resource IDs.

        Note: This is valid only when you provide resource type. If there is no resource type, you will see an error.
    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConformancePackName — (String)

        Name of the conformance pack.

      • ConformancePackRuleEvaluationResults — (Array<map>)

        Returns a list of ConformancePackEvaluationResult objects.

        • ComplianceType — required — (String)

          The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
          • "INSUFFICIENT_DATA"
        • EvaluationResultIdentifier — required — (map)

          Uniquely identifies an evaluation result.

          • EvaluationResultQualifier — (map)

            Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

            • ConfigRuleName — (String)

              The name of the Config rule that was used in the evaluation.

            • ResourceType — (String)

              The type of Amazon Web Services resource that was evaluated.

            • ResourceId — (String)

              The ID of the evaluated Amazon Web Services resource.

          • OrderingTimestamp — (Date)

            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.

        • ConfigRuleInvokedTime — required — (Date)

          The time when Config rule evaluated Amazon Web Services resource.

        • ResultRecordedTime — required — (Date)

          The time when Config recorded the evaluation result.

        • Annotation — (String)

          Supplementary information about how the evaluation determined the compliance.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getConformancePackComplianceSummary(params = {}, callback) ⇒ AWS.Request

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

Service Reference:

Examples:

Calling the getConformancePackComplianceSummary operation

var params = {
  ConformancePackNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getConformancePackComplianceSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConformancePackNames — (Array<String>)

      Names of conformance packs.

    • Limit — (Integer)

      The maximum number of conformance packs returned on each page.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConformancePackComplianceSummaryList — (Array<map>)

        A list of ConformancePackComplianceSummary objects.

        • ConformancePackName — required — (String)

          The name of the conformance pack name.

        • ConformancePackComplianceStatus — required — (String)

          The status of the conformance pack. The allowed values are COMPLIANT, NON_COMPLIANT and INSUFFICIENT_DATA.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
          • "INSUFFICIENT_DATA"
      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDiscoveredResourceCounts(params = {}, callback) ⇒ AWS.Request

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

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

  2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

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

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

Service Reference:

Examples:

Calling the getDiscoveredResourceCounts operation

var params = {
  limit: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceTypes: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.getDiscoveredResourceCounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceTypes — (Array<String>)

      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.

      Note: 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.
    • limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • totalDiscoveredResources — (Integer)

        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

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

        2. You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request.

        3. Config returns 25 for totalDiscoveredResources.

      • resourceCounts — (Array<map>)

        The list of ResourceCount objects. Each object is listed in descending order by the number of resources.

        • resourceType — (String)

          The resource type (for example, "AWS::EC2::Instance").

          Possible values include:
          • "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"
        • count — (Integer)

          The number of resources.

      • nextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getOrganizationConfigRuleDetailedStatus(params = {}, callback) ⇒ AWS.Request

Returns detailed status for each member account within an organization for a given organization config rule.

Service Reference:

Examples:

Calling the getOrganizationConfigRuleDetailedStatus operation

var params = {
  OrganizationConfigRuleName: 'STRING_VALUE', /* required */
  Filters: {
    AccountId: 'STRING_VALUE',
    MemberAccountRuleStatus: CREATE_SUCCESSFUL | CREATE_IN_PROGRESS | CREATE_FAILED | DELETE_SUCCESSFUL | DELETE_FAILED | DELETE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_IN_PROGRESS | UPDATE_FAILED
  },
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getOrganizationConfigRuleDetailedStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConfigRuleName — (String)

      The name of organization config rule for which you want status details for member accounts.

    • Filters — (map)

      A StatusDetailFilters object.

      • AccountId — (String)

        The 12-digit account ID of the member account within an organization.

      • MemberAccountRuleStatus — (String)

        Indicates deployment status for config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

        Config sets the state of the rule to:

        • CREATE_SUCCESSFUL when config rule has been created in the member account.

        • CREATE_IN_PROGRESS when config rule is being created in the member account.

        • CREATE_FAILED when config rule creation has failed in the member account.

        • DELETE_FAILED when config rule deletion has failed in the member account.

        • DELETE_IN_PROGRESS when config rule is being deleted in the member account.

        • DELETE_SUCCESSFUL when config rule has been deleted in the member account.

        • UPDATE_SUCCESSFUL when config rule has been updated in the member account.

        • UPDATE_IN_PROGRESS when config rule is being updated in the member account.

        • UPDATE_FAILED when config rule deletion has failed in the member account.

        Possible values include:
        • "CREATE_SUCCESSFUL"
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_SUCCESSFUL"
        • "DELETE_FAILED"
        • "DELETE_IN_PROGRESS"
        • "UPDATE_SUCCESSFUL"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_FAILED"
    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationConfigRuleDetailedStatus — (Array<map>)

        A list of MemberAccountStatus objects.

        • AccountId — required — (String)

          The 12-digit account ID of a member account.

        • ConfigRuleName — required — (String)

          The name of config rule deployed in the member account.

        • MemberAccountRuleStatus — required — (String)

          Indicates deployment status for config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

          Config sets the state of the rule to:

          • CREATE_SUCCESSFUL when config rule has been created in the member account.

          • CREATE_IN_PROGRESS when config rule is being created in the member account.

          • CREATE_FAILED when config rule creation has failed in the member account.

          • DELETE_FAILED when config rule deletion has failed in the member account.

          • DELETE_IN_PROGRESS when config rule is being deleted in the member account.

          • DELETE_SUCCESSFUL when config rule has been deleted in the member account.

          • UPDATE_SUCCESSFUL when config rule has been updated in the member account.

          • UPDATE_IN_PROGRESS when config rule is being updated in the member account.

          • UPDATE_FAILED when config rule deletion has failed in the member account.

          Possible values include:
          • "CREATE_SUCCESSFUL"
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "DELETE_SUCCESSFUL"
          • "DELETE_FAILED"
          • "DELETE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
        • ErrorCode — (String)

          An error code that is returned when config rule creation or deletion failed in the member account.

        • ErrorMessage — (String)

          An error message indicating that config rule account creation or deletion has failed due to an error in the member account.

        • LastUpdateTime — (Date)

          The timestamp of the last status update.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getOrganizationConformancePackDetailedStatus(params = {}, callback) ⇒ AWS.Request

Returns detailed status for each member account within an organization for a given organization conformance pack.

Service Reference:

Examples:

Calling the getOrganizationConformancePackDetailedStatus operation

var params = {
  OrganizationConformancePackName: 'STRING_VALUE', /* required */
  Filters: {
    AccountId: 'STRING_VALUE',
    Status: CREATE_SUCCESSFUL | CREATE_IN_PROGRESS | CREATE_FAILED | DELETE_SUCCESSFUL | DELETE_FAILED | DELETE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_IN_PROGRESS | UPDATE_FAILED
  },
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.getOrganizationConformancePackDetailedStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConformancePackName — (String)

      The name of organization conformance pack for which you want status details for member accounts.

    • Filters — (map)

      An OrganizationResourceDetailedStatusFilters object.

      • AccountId — (String)

        The 12-digit account ID of the member account within an organization.

      • Status — (String)

        Indicates deployment status for conformance pack in a member account. When master account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When master account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the master account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

        Config sets the state of the conformance pack to:

        • CREATE_SUCCESSFUL when conformance pack has been created in the member account.

        • CREATE_IN_PROGRESS when conformance pack is being created in the member account.

        • CREATE_FAILED when conformance pack creation has failed in the member account.

        • DELETE_FAILED when conformance pack deletion has failed in the member account.

        • DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.

        • DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.

        • UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.

        • UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.

        • UPDATE_FAILED when conformance pack deletion has failed in the member account.

        Possible values include:
        • "CREATE_SUCCESSFUL"
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_SUCCESSFUL"
        • "DELETE_FAILED"
        • "DELETE_IN_PROGRESS"
        • "UPDATE_SUCCESSFUL"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_FAILED"
    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationConformancePackDetailedStatuses — (Array<map>)

        A list of OrganizationConformancePackDetailedStatus objects.

        • AccountId — required — (String)

          The 12-digit account ID of a member account.

        • ConformancePackName — required — (String)

          The name of conformance pack deployed in the member account.

        • Status — required — (String)

          Indicates deployment status for conformance pack in a member account. When master account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When master account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the master account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

          Config sets the state of the conformance pack to:

          • CREATE_SUCCESSFUL when conformance pack has been created in the member account.

          • CREATE_IN_PROGRESS when conformance pack is being created in the member account.

          • CREATE_FAILED when conformance pack creation has failed in the member account.

          • DELETE_FAILED when conformance pack deletion has failed in the member account.

          • DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.

          • DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.

          • UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.

          • UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.

          • UPDATE_FAILED when conformance pack deletion has failed in the member account.

          Possible values include:
          • "CREATE_SUCCESSFUL"
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED"
          • "DELETE_SUCCESSFUL"
          • "DELETE_FAILED"
          • "DELETE_IN_PROGRESS"
          • "UPDATE_SUCCESSFUL"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED"
        • ErrorCode — (String)

          An error code that is returned when conformance pack creation or deletion failed in the member account.

        • ErrorMessage — (String)

          An error message indicating that conformance pack account creation or deletion has failed due to an error in the member account.

        • LastUpdateTime — (Date)

          The timestamp of the last status update.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getResourceConfigHistory(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the getResourceConfigHistory operation

var params = {
  resourceId: 'STRING_VALUE', /* 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, /* required */
  chronologicalOrder: Reverse | Forward,
  earlierTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  laterTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  limit: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
configservice.getResourceConfigHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceType — (String)

      The resource type.

      Possible values include:
      • "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"
    • resourceId — (String)

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

    • laterTime — (Date)

      The time stamp that indicates a later time. If not specified, current time is taken.

    • earlierTime — (Date)

      The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

    • chronologicalOrder — (String)

      The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

      Possible values include:
      • "Reverse"
      • "Forward"
    • limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • configurationItems — (Array<map>)

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

        • version — (String)

          The version number of the resource configuration.

        • accountId — (String)

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

        • configurationItemCaptureTime — (Date)

          The time when the configuration recording was initiated.

        • configurationItemStatus — (String)

          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

          Note: The CIs do not incur any cost.
          Possible values include:
          • "OK"
          • "ResourceDiscovered"
          • "ResourceNotRecorded"
          • "ResourceDeleted"
          • "ResourceDeletedNotRecorded"
        • configurationStateId — (String)

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

        • configurationItemMD5Hash — (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.

        • arn — (String)

          Amazon Resource Name (ARN) associated with the resource.

        • resourceType — (String)

          The type of Amazon Web Services resource.

          Possible values include:
          • "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"
        • resourceId — (String)

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

        • resourceName — (String)

          The custom name of the resource, if available.

        • awsRegion — (String)

          The region where the resource resides.

        • availabilityZone — (String)

          The Availability Zone associated with the resource.

        • resourceCreationTime — (Date)

          The time stamp when the resource was created.

        • tags — (map<String>)

          A mapping of key value tags associated with the resource.

        • relatedEvents — (Array<String>)

          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 — (Array<map>)

          A list of related Amazon Web Services resources.

          • resourceType — (String)

            The resource type of the related resource.

            Possible values include:
            • "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"
          • resourceId — (String)

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

          • resourceName — (String)

            The custom name of the related resource, if available.

          • relationshipName — (String)

            The type of relationship with the related resource.

        • configuration — (String)

          The description of the resource configuration.

        • supplementaryConfiguration — (map<String>)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getStoredQuery(params = {}, callback) ⇒ AWS.Request

Returns the details of a specific stored query.

Service Reference:

Examples:

Calling the getStoredQuery operation

var params = {
  QueryName: 'STRING_VALUE' /* required */
};
configservice.getStoredQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • QueryName — (String)

      The name of the query.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StoredQuery — (map)

        Returns a StoredQuery object.

        • QueryId — (String)

          The ID of the query.

        • QueryArn — (String)

          Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

        • QueryName — required — (String)

          The name of the query.

        • Description — (String)

          A unique description for the query.

        • Expression — (String)

          The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listAggregateDiscoveredResources(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listAggregateDiscoveredResources operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* 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, /* required */
  Filters: {
    AccountId: 'STRING_VALUE',
    Region: 'STRING_VALUE',
    ResourceId: 'STRING_VALUE',
    ResourceName: 'STRING_VALUE'
  },
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.listAggregateDiscoveredResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • ResourceType — (String)

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

      Possible values include:
      • "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"
    • Filters — (map)

      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.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceIdentifiers — (Array<map>)

        Returns a list of ResourceIdentifiers objects.

        • SourceAccountId — required — (String)

          The 12-digit account ID of the source account.

        • SourceRegion — required — (String)

          The source region where data is aggregated.

        • ResourceId — required — (String)

          The ID of the Amazon Web Services resource.

        • ResourceType — required — (String)

          The type of the Amazon Web Services resource.

          Possible values include:
          • "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"
        • ResourceName — (String)

          The name of the Amazon Web Services 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDiscoveredResources(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listDiscoveredResources operation

var params = {
  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, /* required */
  includeDeletedResources: true || false,
  limit: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceName: 'STRING_VALUE'
};
configservice.listDiscoveredResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceType — (String)

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

      Possible values include:
      • "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"
    • resourceIds — (Array<String>)

      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.

    • resourceName — (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.

    • limit — (Integer)

      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.

    • includeDeletedResources — (Boolean)

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

    • nextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourceIdentifiers — (Array<map>)

        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.

          Possible values include:
          • "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"
        • resourceId — (String)

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

        • resourceName — (String)

          The custom name of the resource (if available).

        • resourceDeletionTime — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listStoredQueries(params = {}, callback) ⇒ AWS.Request

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.

Service Reference:

Examples:

Calling the listStoredQueries operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.listStoredQueries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to be returned with a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • StoredQueryMetadata — (Array<map>)

        A list of StoredQueryMetadata objects.

        • QueryId — required — (String)

          The ID of the query.

        • QueryArn — required — (String)

          Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

        • QueryName — required — (String)

          The name of the query.

        • Description — (String)

          A unique description for the query.

      • NextToken — (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's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List the tags for Config resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

    • Limit — (Integer)

      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 — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The tags for the resource.

        • Key — (String)

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • Value — (String)

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putAggregationAuthorization(params = {}, callback) ⇒ AWS.Request

Authorizes the aggregator account and region to collect data from the source account and region.

Service Reference:

Examples:

Calling the putAggregationAuthorization operation

var params = {
  AuthorizedAccountId: 'STRING_VALUE', /* required */
  AuthorizedAwsRegion: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.putAggregationAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AuthorizedAccountId — (String)

      The 12-digit account ID of the account authorized to aggregate data.

    • AuthorizedAwsRegion — (String)

      The region authorized to collect aggregated data.

    • Tags — (Array<map>)

      An array of tag object.

      • Key — (String)

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — (String)

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AggregationAuthorization — (map)

        Returns an AggregationAuthorization object.

        • AggregationAuthorizationArn — (String)

          The Amazon Resource Name (ARN) of the aggregation object.

        • AuthorizedAccountId — (String)

          The 12-digit account ID of the account authorized to aggregate data.

        • AuthorizedAwsRegion — (String)

          The region authorized to collect aggregated data.

        • CreationTime — (Date)

          The time stamp when the aggregation authorization was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putConfigRule(params = {}, callback) ⇒ AWS.Request

Adds or updates an Config rule for evaluating whether your Amazon Web Services resources comply with your desired configurations.

You can use this action for custom Config rules and Config managed rules. A custom Config rule is a rule that you develop and maintain. An Config managed rule is a customizable, predefined rule that Config provides.

If you are adding a new custom Config rule, you must first create the Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

If you are adding an Config managed rule, specify the rule's identifier for the SourceIdentifier key. To reference Config managed rule identifiers, see About Config managed rules.

For any new 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.

The maximum number of rules that Config supports is 150.

For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide.

Service Reference:

Examples:

Calling the putConfigRule operation

var params = {
  ConfigRule: { /* required */
    Source: { /* required */
      Owner: CUSTOM_LAMBDA | AWS, /* required */
      SourceIdentifier: 'STRING_VALUE', /* required */
      SourceDetails: [
        {
          EventSource: aws.config,
          MaximumExecutionFrequency: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours,
          MessageType: ConfigurationItemChangeNotification | ConfigurationSnapshotDeliveryCompleted | ScheduledNotification | OversizedConfigurationItemChangeNotification
        },
        /* more items */
      ]
    },
    ConfigRuleArn: 'STRING_VALUE',
    ConfigRuleId: 'STRING_VALUE',
    ConfigRuleName: 'STRING_VALUE',
    ConfigRuleState: ACTIVE | DELETING | DELETING_RESULTS | EVALUATING,
    CreatedBy: 'STRING_VALUE',
    Description: 'STRING_VALUE',
    InputParameters: 'STRING_VALUE',
    MaximumExecutionFrequency: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours,
    Scope: {
      ComplianceResourceId: 'STRING_VALUE',
      ComplianceResourceTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      TagKey: 'STRING_VALUE',
      TagValue: 'STRING_VALUE'
    }
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.putConfigRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRule — (map)

      The rule that you want to add to your account.

      • ConfigRuleName — (String)

        The name that you assign to the Config rule. The name is required if you are adding a new rule.

      • ConfigRuleArn — (String)

        The Amazon Resource Name (ARN) of the Config rule.

      • ConfigRuleId — (String)

        The ID of the Config rule.

      • Description — (String)

        The description that you provide for the Config rule.

      • Scope — (map)

        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.

        Note: The scope can be empty.
        • ComplianceResourceTypes — (Array<String>)

          The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

        • TagKey — (String)

          The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

        • TagValue — (String)

          The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

        • ComplianceResourceId — (String)

          The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

      • Source — required — (map)

        Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

        • Owner — required — (String)

          Indicates whether Amazon Web Services or the customer owns and manages the Config rule.

          Possible values include:
          • "CUSTOM_LAMBDA"
          • "AWS"
        • SourceIdentifier — required — (String)

          For Config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

          For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.

        • SourceDetails — (Array<map>)

          Provides the source and type of the event that causes Config to evaluate your Amazon Web Services resources.

          • EventSource — (String)

            The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

            Possible values include:
            • "aws.config"
          • MessageType — (String)

            The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

            • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

            • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

            • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

            • ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a configuration snapshot.

            If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

            Possible values include:
            • "ConfigurationItemChangeNotification"
            • "ConfigurationSnapshotDeliveryCompleted"
            • "ScheduledNotification"
            • "OversizedConfigurationItemChangeNotification"
          • MaximumExecutionFrequency — (String)

            The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

            Note: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter. Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.
            Possible values include:
            • "One_Hour"
            • "Three_Hours"
            • "Six_Hours"
            • "Twelve_Hours"
            • "TwentyFour_Hours"
      • InputParameters — (String)

        A string, in JSON format, that is passed to the Config rule Lambda function.

      • MaximumExecutionFrequency — (String)

        The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

        • You are using 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.

        Note: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
        Possible values include:
        • "One_Hour"
        • "Three_Hours"
        • "Six_Hours"
        • "Twelve_Hours"
        • "TwentyFour_Hours"
      • ConfigRuleState — (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 the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

        Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.

        Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

        Possible values include:
        • "ACTIVE"
        • "DELETING"
        • "DELETING_RESULTS"
        • "EVALUATING"
      • CreatedBy — (String)

        Service principal name of the service that created the rule.

        Note: 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.
    • Tags — (Array<map>)

      An array of tag object.

      • Key — (String)

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — (String)

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putConfigurationAggregator(params = {}, callback) ⇒ AWS.Request

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 DescribeAggregator to get the previous accounts and then append new ones.

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

Service Reference:

Examples:

Calling the putConfigurationAggregator operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  AccountAggregationSources: [
    {
      AccountIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      AllAwsRegions: true || false,
      AwsRegions: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  OrganizationAggregationSource: {
    RoleArn: 'STRING_VALUE', /* required */
    AllAwsRegions: true || false,
    AwsRegions: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.putConfigurationAggregator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • AccountAggregationSources — (Array<map>)

      A list of AccountAggregationSource object.

      • AccountIds — required — (Array<String>)

        The 12-digit account ID of the account being aggregated.

      • AllAwsRegions — (Boolean)

        If true, aggregate existing Config regions and future regions.

      • AwsRegions — (Array<String>)

        The source regions being aggregated.

    • OrganizationAggregationSource — (map)

      An OrganizationAggregationSource object.

      • RoleArn — required — (String)

        ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.

      • AwsRegions — (Array<String>)

        The source regions being aggregated.

      • AllAwsRegions — (Boolean)

        If true, aggregate existing Config regions and future regions.

    • Tags — (Array<map>)

      An array of tag object.

      • Key — (String)

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — (String)

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationAggregator — (map)

        Returns a ConfigurationAggregator object.

        • ConfigurationAggregatorName — (String)

          The name of the aggregator.

        • ConfigurationAggregatorArn — (String)

          The Amazon Resource Name (ARN) of the aggregator.

        • AccountAggregationSources — (Array<map>)

          Provides a list of source accounts and regions to be aggregated.

          • AccountIds — required — (Array<String>)

            The 12-digit account ID of the account being aggregated.

          • AllAwsRegions — (Boolean)

            If true, aggregate existing Config regions and future regions.

          • AwsRegions — (Array<String>)

            The source regions being aggregated.

        • OrganizationAggregationSource — (map)

          Provides an organization and list of regions to be aggregated.

          • RoleArn — required — (String)

            ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.

          • AwsRegions — (Array<String>)

            The source regions being aggregated.

          • AllAwsRegions — (Boolean)

            If true, aggregate existing Config regions and future regions.

        • CreationTime — (Date)

          The time stamp when the configuration aggregator was created.

        • LastUpdatedTime — (Date)

          The time of the last update.

        • CreatedBy — (String)

          Amazon Web Services service that created the configuration aggregator.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putConfigurationRecorder(params = {}, callback) ⇒ AWS.Request

Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Note: Currently, you can specify only one configuration recorder per region in your account. If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Service Reference:

Examples:

Calling the putConfigurationRecorder operation

var params = {
  ConfigurationRecorder: { /* required */
    name: 'STRING_VALUE',
    recordingGroup: {
      allSupported: true || false,
      includeGlobalResourceTypes: true || false,
      resourceTypes: [
        AWS::EC2::CustomerGateway | AWS::EC2::EIP | AWS::EC2::Host | AWS::EC2::Instance | AWS::EC2::InternetGateway | AWS::EC2::NetworkAcl | AWS::EC2::NetworkInterface | AWS::EC2::RouteTable | AWS::EC2::SecurityGroup | AWS::EC2::Subnet | AWS::CloudTrail::Trail | AWS::EC2::Volume | AWS::EC2::VPC | AWS::EC2::VPNConnection | AWS::EC2::VPNGateway | AWS::EC2::RegisteredHAInstance | AWS::EC2::NatGateway | AWS::EC2::EgressOnlyInternetGateway | AWS::EC2::VPCEndpoint | AWS::EC2::VPCEndpointService | AWS::EC2::FlowLog | AWS::EC2::VPCPeeringConnection | AWS::Elasticsearch::Domain | AWS::IAM::Group | AWS::IAM::Policy | AWS::IAM::Role | AWS::IAM::User | AWS::ElasticLoadBalancingV2::LoadBalancer | AWS::ACM::Certificate | AWS::RDS::DBInstance | AWS::RDS::DBSubnetGroup | AWS::RDS::DBSecurityGroup | AWS::RDS::DBSnapshot | AWS::RDS::DBCluster | AWS::RDS::DBClusterSnapshot | AWS::RDS::EventSubscription | AWS::S3::Bucket | AWS::S3::AccountPublicAccessBlock | AWS::Redshift::Cluster | AWS::Redshift::ClusterSnapshot | AWS::Redshift::ClusterParameterGroup | AWS::Redshift::ClusterSecurityGroup | AWS::Redshift::ClusterSubnetGroup | AWS::Redshift::EventSubscription | AWS::SSM::ManagedInstanceInventory | AWS::CloudWatch::Alarm | AWS::CloudFormation::Stack | AWS::ElasticLoadBalancing::LoadBalancer | AWS::AutoScaling::AutoScalingGroup | AWS::AutoScaling::LaunchConfiguration | AWS::AutoScaling::ScalingPolicy | AWS::AutoScaling::ScheduledAction | AWS::DynamoDB::Table | AWS::CodeBuild::Project | AWS::WAF::RateBasedRule | AWS::WAF::Rule | AWS::WAF::RuleGroup | AWS::WAF::WebACL | AWS::WAFRegional::RateBasedRule | AWS::WAFRegional::Rule | AWS::WAFRegional::RuleGroup | AWS::WAFRegional::WebACL | AWS::CloudFront::Distribution | AWS::CloudFront::StreamingDistribution | AWS::Lambda::Function | AWS::NetworkFirewall::Firewall | AWS::NetworkFirewall::FirewallPolicy | AWS::NetworkFirewall::RuleGroup | AWS::ElasticBeanstalk::Application | AWS::ElasticBeanstalk::ApplicationVersion | AWS::ElasticBeanstalk::Environment | AWS::WAFv2::WebACL | AWS::WAFv2::RuleGroup | AWS::WAFv2::IPSet | AWS::WAFv2::RegexPatternSet | AWS::WAFv2::ManagedRuleSet | AWS::XRay::EncryptionConfig | AWS::SSM::AssociationCompliance | AWS::SSM::PatchCompliance | AWS::Shield::Protection | AWS::ShieldRegional::Protection | AWS::Config::ConformancePackCompliance | AWS::Config::ResourceCompliance | AWS::ApiGateway::Stage | AWS::ApiGateway::RestApi | AWS::ApiGatewayV2::Stage | AWS::ApiGatewayV2::Api | AWS::CodePipeline::Pipeline | AWS::ServiceCatalog::CloudFormationProvisionedProduct | AWS::ServiceCatalog::CloudFormationProduct | AWS::ServiceCatalog::Portfolio | AWS::SQS::Queue | AWS::KMS::Key | AWS::QLDB::Ledger | AWS::SecretsManager::Secret | AWS::SNS::Topic | AWS::SSM::FileData | AWS::Backup::BackupPlan | AWS::Backup::BackupSelection | AWS::Backup::BackupVault | AWS::Backup::RecoveryPoint | AWS::ECR::Repository | AWS::ECS::Cluster | AWS::ECS::Service | AWS::ECS::TaskDefinition | AWS::EFS::AccessPoint | AWS::EFS::FileSystem | AWS::EKS::Cluster | AWS::OpenSearch::Domain,
        /* more items */
      ]
    },
    roleARN: 'STRING_VALUE'
  }
};
configservice.putConfigurationRecorder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationRecorder — (map)

      The configuration recorder object that records each configuration change made to the resources.

      • name — (String)

        The name of the recorder. By default, Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.

      • roleARN — (String)

        Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.

      • recordingGroup — (map)

        Specifies the types of Amazon Web Services resources for which Config records configuration changes.

        • allSupported — (Boolean)

          Specifies whether Config records configuration changes for every supported type of regional resource.

          If you set this option to true, when Config adds support for a new type of regional resource, it starts recording resources of that type automatically.

          If you set this option to true, you cannot enumerate a list of resourceTypes.

        • includeGlobalResourceTypes — (Boolean)

          Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

          Before you can set this option to true, you must set the allSupported option to true.

          If you set this option to true, when Config adds support for a new type of global resource, it starts recording resources of that type automatically.

          The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.

        • resourceTypes — (Array<String>)

          A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

          To record all configuration changes, you must set the allSupported option to true.

          If you set this option to false, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

          For a list of valid resourceTypes values, see the resourceType Value column in Supported Amazon Web Services resource Types.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putConformancePack(params = {}, callback) ⇒ AWS.Request

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 Amazon Web Services Organization.

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.

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

Service Reference:

Examples:

Calling the putConformancePack operation

var params = {
  ConformancePackName: 'STRING_VALUE', /* required */
  ConformancePackInputParameters: [
    {
      ParameterName: 'STRING_VALUE', /* required */
      ParameterValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  DeliveryS3Bucket: 'STRING_VALUE',
  DeliveryS3KeyPrefix: 'STRING_VALUE',
  TemplateBody: 'STRING_VALUE',
  TemplateS3Uri: 'STRING_VALUE'
};
configservice.putConformancePack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConformancePackName — (String)

      Name of the conformance pack you want to create.

    • TemplateS3Uri — (String)

      Location of file containing the template body (s3://bucketname/prefix). The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.

      Note: You must have access to read Amazon S3 bucket.
    • TemplateBody — (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.

      Note: You can only use a YAML template with one resource type, that is, config rule and a remediation action.
    • DeliveryS3Bucket — (String)

      The name of the Amazon S3 bucket where Config stores conformance pack templates.

      Note: This field is optional.
    • DeliveryS3KeyPrefix — (String)

      The prefix for the Amazon S3 bucket.

      Note: This field is optional.
    • ConformancePackInputParameters — (Array<map>)

      A list of ConformancePackInputParameter objects.

      • ParameterName — required — (String)

        One part of a key-value pair.

      • ParameterValue — required — (String)

        Another part of the key-value pair.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConformancePackArn — (String)

        ARN of the conformance pack.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putDeliveryChannel(params = {}, callback) ⇒ AWS.Request

Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and 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.

Note: You can have only one delivery channel per region in your account.

Service Reference:

Examples:

Calling the putDeliveryChannel operation

var params = {
  DeliveryChannel: { /* required */
    configSnapshotDeliveryProperties: {
      deliveryFrequency: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours
    },
    name: 'STRING_VALUE',
    s3BucketName: 'STRING_VALUE',
    s3KeyPrefix: 'STRING_VALUE',
    s3KmsKeyArn: 'STRING_VALUE',
    snsTopicARN: 'STRING_VALUE'
  }
};
configservice.putDeliveryChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeliveryChannel — (map)

      The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.

      • name — (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 — (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 — (String)

        The prefix for the specified Amazon S3 bucket.

      • s3KmsKeyArn — (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 — (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.

      • configSnapshotDeliveryProperties — (map)

        The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

        • deliveryFrequency — (String)

          The frequency with which Config delivers configuration snapshots.

          Possible values include:
          • "One_Hour"
          • "Three_Hours"
          • "Six_Hours"
          • "Twelve_Hours"
          • "TwentyFour_Hours"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putEvaluations(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putEvaluations operation

var params = {
  ResultToken: 'STRING_VALUE', /* required */
  Evaluations: [
    {
      ComplianceResourceId: 'STRING_VALUE', /* required */
      ComplianceResourceType: 'STRING_VALUE', /* required */
      ComplianceType: COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA, /* required */
      OrderingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      Annotation: 'STRING_VALUE'
    },
    /* more items */
  ],
  TestMode: true || false
};
configservice.putEvaluations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Evaluations — (Array<map>)

      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.

      • ComplianceResourceType — required — (String)

        The type of Amazon Web Services resource that was evaluated.

      • ComplianceResourceId — required — (String)

        The ID of the Amazon Web Services resource that was evaluated.

      • ComplianceType — required — (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 the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

        Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

        Possible values include:
        • "COMPLIANT"
        • "NON_COMPLIANT"
        • "NOT_APPLICABLE"
        • "INSUFFICIENT_DATA"
      • Annotation — (String)

        Supplementary information about how the evaluation determined the compliance.

      • OrderingTimestamp — required — (Date)

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

    • ResultToken — (String)

      An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.

    • TestMode — (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.

      Note: When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FailedEvaluations — (Array<map>)

        Requests that failed because of a client or server error.

        • ComplianceResourceType — required — (String)

          The type of Amazon Web Services resource that was evaluated.

        • ComplianceResourceId — required — (String)

          The ID of the Amazon Web Services resource that was evaluated.

        • ComplianceType — required — (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 the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

          Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

          Possible values include:
          • "COMPLIANT"
          • "NON_COMPLIANT"
          • "NOT_APPLICABLE"
          • "INSUFFICIENT_DATA"
        • Annotation — (String)

          Supplementary information about how the evaluation determined the compliance.

        • OrderingTimestamp — required — (Date)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putExternalEvaluation(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putExternalEvaluation operation

var params = {
  ConfigRuleName: 'STRING_VALUE', /* required */
  ExternalEvaluation: { /* required */
    ComplianceResourceId: 'STRING_VALUE', /* required */
    ComplianceResourceType: 'STRING_VALUE', /* required */
    ComplianceType: COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA, /* required */
    OrderingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    Annotation: 'STRING_VALUE'
  }
};
configservice.putExternalEvaluation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The name of the Config rule.

    • ExternalEvaluation — (map)

      An ExternalEvaluation object that provides details about compliance.

      • ComplianceResourceType — required — (String)

        The evaluated compliance resource type. Config accepts AWS::::Account resource type.

      • ComplianceResourceId — required — (String)

        The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.

      • ComplianceType — required — (String)

        The compliance of the Amazon Web Services resource. The valid values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

        Possible values include:
        • "COMPLIANT"
        • "NON_COMPLIANT"
        • "NOT_APPLICABLE"
        • "INSUFFICIENT_DATA"
      • Annotation — (String)

        Supplementary information about the reason of compliance. For example, this task was completed on a specific date.

      • OrderingTimestamp — required — (Date)

        The time when the compliance was recorded.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putOrganizationConfigRule(params = {}, callback) ⇒ AWS.Request

Adds or updates organization config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your desired configurations.

Only a master 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.

This API enables organization service access through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master 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.

You can use this action to create both custom Config rules and Config managed rules. If you are adding a new custom Config rule, you must first create Lambda function in the master 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 the PutOrganizationConfigRule action to add the rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. If you are adding an Config managed rule, specify the rule's identifier for the RuleIdentifier key.

The maximum number of organization config rules that Config supports is 150 and 3 delegated administrator per organization.

Note: Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.

Service Reference:

Examples:

Calling the putOrganizationConfigRule operation

var params = {
  OrganizationConfigRuleName: 'STRING_VALUE', /* required */
  ExcludedAccounts: [
    'STRING_VALUE',
    /* more items */
  ],
  OrganizationCustomRuleMetadata: {
    LambdaFunctionArn: 'STRING_VALUE', /* required */
    OrganizationConfigRuleTriggerTypes: [ /* required */
      ConfigurationItemChangeNotification | OversizedConfigurationItemChangeNotification | ScheduledNotification,
      /* more items */
    ],
    Description: 'STRING_VALUE',
    InputParameters: 'STRING_VALUE',
    MaximumExecutionFrequency: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours,
    ResourceIdScope: 'STRING_VALUE',
    ResourceTypesScope: [
      'STRING_VALUE',
      /* more items */
    ],
    TagKeyScope: 'STRING_VALUE',
    TagValueScope: 'STRING_VALUE'
  },
  OrganizationManagedRuleMetadata: {
    RuleIdentifier: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE',
    InputParameters: 'STRING_VALUE',
    MaximumExecutionFrequency: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours,
    ResourceIdScope: 'STRING_VALUE',
    ResourceTypesScope: [
      'STRING_VALUE',
      /* more items */
    ],
    TagKeyScope: 'STRING_VALUE',
    TagValueScope: 'STRING_VALUE'
  }
};
configservice.putOrganizationConfigRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConfigRuleName — (String)

      The name that you assign to an organization config rule.

    • OrganizationManagedRuleMetadata — (map)

      An OrganizationManagedRuleMetadata object.

      • Description — (String)

        The description that you provide for organization config rule.

      • RuleIdentifier — required — (String)

        For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

      • InputParameters — (String)

        A string, in JSON format, that is passed to organization config rule Lambda function.

      • MaximumExecutionFrequency — (String)

        The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.

        Note: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
        Possible values include:
        • "One_Hour"
        • "Three_Hours"
        • "Six_Hours"
        • "Twelve_Hours"
        • "TwentyFour_Hours"
      • ResourceTypesScope — (Array<String>)

        The type of the Amazon Web Services resource that was evaluated.

      • ResourceIdScope — (String)

        The ID of the Amazon Web Services resource that was evaluated.

      • TagKeyScope — (String)

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • TagValueScope — (String)

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    • OrganizationCustomRuleMetadata — (map)

      An OrganizationCustomRuleMetadata object.

      • Description — (String)

        The description that you provide for organization config rule.

      • LambdaFunctionArn — required — (String)

        The lambda function ARN.

      • OrganizationConfigRuleTriggerTypes — required — (Array<String>)

        The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

        • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

        • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

        • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

      • InputParameters — (String)

        A string, in JSON format, that is passed to organization config rule Lambda function.

      • MaximumExecutionFrequency — (String)

        The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

        Note: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
        Possible values include:
        • "One_Hour"
        • "Three_Hours"
        • "Six_Hours"
        • "Twelve_Hours"
        • "TwentyFour_Hours"
      • ResourceTypesScope — (Array<String>)

        The type of the Amazon Web Services resource that was evaluated.

      • ResourceIdScope — (String)

        The ID of the Amazon Web Services resource that was evaluated.

      • TagKeyScope — (String)

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • TagValueScope — (String)

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    • ExcludedAccounts — (Array<String>)

      A comma-separated list of accounts that you want to exclude from an organization config rule.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationConfigRuleArn — (String)

        The Amazon Resource Name (ARN) of an organization config rule.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putOrganizationConformancePack(params = {}, callback) ⇒ AWS.Request

Deploys conformance packs across member accounts in an Amazon Web Services Organization.

Only a master 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.

This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master 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.

Note: 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. You can create 50 conformance packs with 25 Config rules in each pack and 3 delegated administrator per organization.

Service Reference:

Examples:

Calling the putOrganizationConformancePack operation

var params = {
  OrganizationConformancePackName: 'STRING_VALUE', /* required */
  ConformancePackInputParameters: [
    {
      ParameterName: 'STRING_VALUE', /* required */
      ParameterValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  DeliveryS3Bucket: 'STRING_VALUE',
  DeliveryS3KeyPrefix: 'STRING_VALUE',
  ExcludedAccounts: [
    'STRING_VALUE',
    /* more items */
  ],
  TemplateBody: 'STRING_VALUE',
  TemplateS3Uri: 'STRING_VALUE'
};
configservice.putOrganizationConformancePack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OrganizationConformancePackName — (String)

      Name of the organization conformance pack you want to create.

    • TemplateS3Uri — (String)

      Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

      Note: You must have access to read Amazon S3 bucket.
    • TemplateBody — (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.

    • DeliveryS3Bucket — (String)

      The name of the Amazon S3 bucket where Config stores conformance pack templates.

      Note: This field is optional. If used, it must be prefixed with awsconfigconforms.
    • DeliveryS3KeyPrefix — (String)

      The prefix for the Amazon S3 bucket.

      Note: This field is optional.
    • ConformancePackInputParameters — (Array<map>)

      A list of ConformancePackInputParameter objects.

      • ParameterName — required — (String)

        One part of a key-value pair.

      • ParameterValue — required — (String)

        Another part of the key-value pair.

    • ExcludedAccounts — (Array<String>)

      A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrganizationConformancePackArn — (String)

        ARN of the organization conformance pack.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putRemediationConfigurations(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the putRemediationConfigurations operation

var params = {
  RemediationConfigurations: [ /* required */
    {
      ConfigRuleName: 'STRING_VALUE', /* required */
      TargetId: 'STRING_VALUE', /* required */
      TargetType: SSM_DOCUMENT, /* required */
      Arn: 'STRING_VALUE',
      Automatic: true || false,
      CreatedByService: 'STRING_VALUE',
      ExecutionControls: {
        SsmControls: {
          ConcurrentExecutionRatePercentage: 'NUMBER_VALUE',
          ErrorPercentage: 'NUMBER_VALUE'
        }
      },
      MaximumAutomaticAttempts: 'NUMBER_VALUE',
      Parameters: {
        '<StringWithCharLimit256>': {
          ResourceValue: {
            Value: RESOURCE_ID /* required */
          },
          StaticValue: {
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          }
        },
        /* '<StringWithCharLimit256>': ... */
      },
      ResourceType: 'STRING_VALUE',
      RetryAttemptSeconds: 'NUMBER_VALUE',
      TargetVersion: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.putRemediationConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RemediationConfigurations — (Array<map>)

      A list of remediation configuration objects.

      • ConfigRuleName — required — (String)

        The name of the Config rule.

      • TargetType — required — (String)

        The type of the target. Target executes remediation. For example, SSM document.

        Possible values include:
        • "SSM_DOCUMENT"
      • TargetId — required — (String)

        Target ID is the name of the public document.

      • TargetVersion — (String)

        Version of the target. For example, version of the SSM document.

        Note: If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
      • Parameters — (map<map>)

        An object of the RemediationParameterValue.

        • ResourceValue — (map)

          The value is dynamic and changes at run-time.

          • Value — required — (String)

            The value is a resource ID.

            Possible values include:
            • "RESOURCE_ID"
        • StaticValue — (map)

          The value is static and does not change at run-time.

          • Values — required — (Array<String>)

            A list of values. For example, the ARN of the assumed role.

      • ResourceType — (String)

        The type of a resource.

      • Automatic — (Boolean)

        The remediation is triggered automatically.

      • ExecutionControls — (map)

        An ExecutionControls object.

        • SsmControls — (map)

          A SsmControls object.

          • ConcurrentExecutionRatePercentage — (Integer)

            The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.

          • ErrorPercentage — (Integer)

            The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

      • MaximumAutomaticAttempts — (Integer)

        The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

        For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

      • RetryAttemptSeconds — (Integer)

        Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

        For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

      • Arn — (String)

        Amazon Resource Name (ARN) of remediation configuration.

      • CreatedByService — (String)

        Name of the service that owns the service linked rule, if applicable.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FailedBatches — (Array<map>)

        Returns a list of failed remediation batch objects.

        • FailureMessage — (String)

          Returns a failure message. For example, the resource is already compliant.

        • FailedItems — (Array<map>)

          Returns remediation configurations of the failed items.

          • ConfigRuleName — required — (String)

            The name of the Config rule.

          • TargetType — required — (String)

            The type of the target. Target executes remediation. For example, SSM document.

            Possible values include:
            • "SSM_DOCUMENT"
          • TargetId — required — (String)

            Target ID is the name of the public document.

          • TargetVersion — (String)

            Version of the target. For example, version of the SSM document.

            Note: If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
          • Parameters — (map<map>)

            An object of the RemediationParameterValue.

            • ResourceValue — (map)

              The value is dynamic and changes at run-time.

              • Value — required — (String)

                The value is a resource ID.

                Possible values include:
                • "RESOURCE_ID"
            • StaticValue — (map)

              The value is static and does not change at run-time.

              • Values — required — (Array<String>)

                A list of values. For example, the ARN of the assumed role.

          • ResourceType — (String)

            The type of a resource.

          • Automatic — (Boolean)

            The remediation is triggered automatically.

          • ExecutionControls — (map)

            An ExecutionControls object.

            • SsmControls — (map)

              A SsmControls object.

              • ConcurrentExecutionRatePercentage — (Integer)

                The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.

              • ErrorPercentage — (Integer)

                The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

          • MaximumAutomaticAttempts — (Integer)

            The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

            For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

          • RetryAttemptSeconds — (Integer)

            Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

            For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

          • Arn — (String)

            Amazon Resource Name (ARN) of remediation configuration.

          • CreatedByService — (String)

            Name of the service that owns the service linked rule, if applicable.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putRemediationExceptions(params = {}, callback) ⇒ AWS.Request

A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific Config rule.

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

Service Reference:

Examples:

Calling the putRemediationExceptions operation

var params = {
  ConfigRuleName: 'STRING_VALUE', /* required */
  ResourceKeys: [ /* required */
    {
      ResourceId: 'STRING_VALUE',
      ResourceType: 'STRING_VALUE'
    },
    /* more items */
  ],
  ExpirationTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Message: 'STRING_VALUE'
};
configservice.putRemediationExceptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The name of the Config rule for which you want to create remediation exception.

    • ResourceKeys — (Array<map>)

      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.

      • ResourceType — (String)

        The type of a resource.

      • ResourceId — (String)

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

    • Message — (String)

      The message contains an explanation of the exception.

    • ExpirationTime — (Date)

      The exception is automatically deleted after the expiration date.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FailedBatches — (Array<map>)

        Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

        • FailureMessage — (String)

          Returns a failure message. For example, the auto-remediation has failed.

        • FailedItems — (Array<map>)

          Returns remediation exception resource key object of the failed items.

          • ConfigRuleName — required — (String)

            The name of the Config rule.

          • ResourceType — required — (String)

            The type of a resource.

          • ResourceId — required — (String)

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

          • Message — (String)

            An explanation of an remediation exception.

          • ExpirationTime — (Date)

            The time when the remediation exception will be deleted.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putResourceConfig(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the putResourceConfig operation

var params = {
  Configuration: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE', /* required */
  SchemaVersionId: 'STRING_VALUE', /* required */
  ResourceName: 'STRING_VALUE',
  Tags: {
    '<Name>': 'STRING_VALUE',
    /* '<Name>': ... */
  }
};
configservice.putResourceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceType — (String)

      The type of the resource. The custom resource type must be registered with CloudFormation.

      Note: 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 — (String)

      Version of the schema registered for the ResourceType in CloudFormation.

    • ResourceId — (String)

      Unique identifier of the resource.

    • ResourceName — (String)

      Name of the resource.

    • Configuration — (String)

      The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.

      Note: The configuration JSON must not exceed 64 KB.
    • Tags — (map<String>)

      Tags associated with the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putRetentionConfiguration(params = {}, callback) ⇒ AWS.Request

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.

Note: Currently, Config supports only one retention configuration per region in your account.

Service Reference:

Examples:

Calling the putRetentionConfiguration operation

var params = {
  RetentionPeriodInDays: 'NUMBER_VALUE' /* required */
};
configservice.putRetentionConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RetentionPeriodInDays — (Integer)

      Number of days Config stores your historical information.

      Note: Currently, only applicable to the configuration item history.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RetentionConfiguration — (map)

        Returns a retention configuration object.

        • Name — required — (String)

          The name of the retention configuration object.

        • RetentionPeriodInDays — required — (Integer)

          Number of days Config stores your historical information.

          Note: Currently, only applicable to the configuration item history.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putStoredQuery(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putStoredQuery operation

var params = {
  StoredQuery: { /* required */
    QueryName: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE',
    Expression: 'STRING_VALUE',
    QueryArn: 'STRING_VALUE',
    QueryId: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.putStoredQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • StoredQuery — (map)

      A list of StoredQuery objects. The mandatory fields are QueryName and Expression.

      Note: 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.
      • QueryId — (String)

        The ID of the query.

      • QueryArn — (String)

        Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

      • QueryName — required — (String)

        The name of the query.

      • Description — (String)

        A unique description for the query.

      • Expression — (String)

        The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.

    • Tags — (Array<map>)

      A list of Tags object.

      • Key — (String)

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — (String)

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • QueryArn — (String)

        Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

selectAggregateResourceConfig(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the selectAggregateResourceConfig operation

var params = {
  ConfigurationAggregatorName: 'STRING_VALUE', /* required */
  Expression: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.selectAggregateResourceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Expression — (String)

      The SQL query SELECT command.

    • ConfigurationAggregatorName — (String)

      The name of the configuration aggregator.

    • Limit — (Integer)

      The maximum number of query results returned on each page.

    • MaxResults — (Integer)

      The maximum number of query results returned on each page. Config also allows the Limit request parameter.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Results — (Array<String>)

        Returns the results for the SQL query.

      • QueryInfo — (map)

        Details about the query.

        • SelectFields — (Array<map>)

          Returns a FieldInfo object.

          • Name — (String)

            Name of the field.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

selectResourceConfig(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the selectResourceConfig operation

var params = {
  Expression: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
configservice.selectResourceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Expression — (String)

      The SQL query SELECT command.

    • Limit — (Integer)

      The maximum number of query results returned on each page.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Results — (Array<String>)

        Returns the results for the SQL query.

      • QueryInfo — (map)

        Returns the QueryInfo object.

        • SelectFields — (Array<map>)

          Returns a FieldInfo object.

          • Name — (String)

            Name of the field.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startConfigRulesEvaluation(params = {}, callback) ⇒ AWS.Request

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.

Note: 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:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

Service Reference:

Examples:

Calling the startConfigRulesEvaluation operation

var params = {
  ConfigRuleNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.startConfigRulesEvaluation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleNames — (Array<String>)

      The list of names of Config rules that you want to run evaluations for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startConfigurationRecorder(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startConfigurationRecorder operation

var params = {
  ConfigurationRecorderName: 'STRING_VALUE' /* required */
};
configservice.startConfigurationRecorder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationRecorderName — (String)

      The name of the recorder object that records each configuration change made to the resources.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startRemediationExecution(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startRemediationExecution operation

var params = {
  ConfigRuleName: 'STRING_VALUE', /* required */
  ResourceKeys: [ /* required */
    {
      resourceId: 'STRING_VALUE', /* 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 /* required */
    },
    /* more items */
  ]
};
configservice.startRemediationExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigRuleName — (String)

      The list of names of Config rules that you want to run remediation execution for.

    • ResourceKeys — (Array<map>)

      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.

      • resourceType — required — (String)

        The resource type.

        Possible values include:
        • "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"
      • resourceId — required — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FailureMessage — (String)

        Returns a failure message. For example, the resource is already compliant.

      • FailedItems — (Array<map>)

        For resources that have failed to start execution, the API returns a resource key object.

        • resourceType — required — (String)

          The resource type.

          Possible values include:
          • "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"
        • resourceId — required — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopConfigurationRecorder(params = {}, callback) ⇒ AWS.Request

Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

Service Reference:

Examples:

Calling the stopConfigurationRecorder operation

var params = {
  ConfigurationRecorderName: 'STRING_VALUE' /* required */
};
configservice.stopConfigurationRecorder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConfigurationRecorderName — (String)

      The name of the recorder object that records each configuration change made to the resources.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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. When a resource is deleted, the tags associated with that resource are deleted as well.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
configservice.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

    • Tags — (Array<map>)

      An array of tag object.

      • Key — (String)

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — (String)

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes specified tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
configservice.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

    • TagKeys — (Array<String>)

      The keys of the tags to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.