Class: AWS.ConfigService

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.