Class: AWS.ConfigService

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

Overview

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

Sending a Request Using ConfigService

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

Locking the API Version

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

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

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

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

var configservice = new AWS.ConfigService();

Version:

  • 2014-11-12

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a ConfigService object

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

Options Hash (options):

  • params (map)

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

  • endpoint (String)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • retryDelayOptions (map)

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

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Deletes the specified AWS Config rule and all of its evaluation results.

AWS Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

Service Reference:

Examples:

Calling the deleteConfigRule operation

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

Parameters:

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

      The name of the AWS 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.

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

Deletes the configuration recorder.

After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder.

This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder.

Service Reference:

Examples:

Calling the deleteConfigurationRecorder operation

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

Parameters:

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

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Deletes the delivery channel.

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

Service Reference:

Examples:

Calling the deleteDeliveryChannel operation

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

Parameters:

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

      The name of the delivery channel to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.

Service Reference:

Examples:

Calling the deleteEvaluationResults operation

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

Parameters:

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

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.

  • Notification of starting the delivery.

  • Notification of delivery completed, if the delivery was successfully completed.

  • Notification of delivery failure, if the delivery failed to complete.

Service Reference:

Examples:

Calling the deliverConfigSnapshot operation

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

Parameters:

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

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • configSnapshotId — (String)

        The ID of the snapshot that is being created.

Returns:

  • (AWS.Request)

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

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

Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply.

If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.

  • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Service Reference:

Examples:

Calling the describeComplianceByConfigRule operation

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

Parameters:

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

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

    • ComplianceTypes — (Array<String>)

      Filters the results by compliance.

      The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

    • NextToken — (String)

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

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 AWS Config rules is compliant.

        • ConfigRuleName — (String)

          The name of the AWS Config rule.

        • Compliance — (map)

          Indicates whether the AWS Config rule is compliant.

          • ComplianceType — (String)

            Indicates whether an AWS resource or AWS Config rule is compliant.

            A resource is compliant if it complies with all of the AWS Config rules that evaluate it, and it 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, and it is noncompliant if any of these resources do not comply.

            AWS Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the AWS resource or Config rule.

            For the Compliance data type, AWS Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. AWS 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 AWS resources or AWS Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

            • CappedCount — (Integer)

              The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.

A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If AWS Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.

  • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Service Reference:

Examples:

Calling the describeComplianceByResource operation

var params = {
  ComplianceTypes: [
    COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA,
    /* more items */
  ],
  Limit: 0,
  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 AWS resources for which you want compliance information; for example, AWS::EC2::Instance. For this action, you can specify that the resource type is an AWS account by specifying AWS::::Account.

    • ResourceId — (String)

      The ID of the AWS 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 limit greater than 100. If you specify 0, AWS 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 AWS resource complies with all of the AWS Config rules that evaluate it.

        • ResourceType — (String)

          The type of the AWS resource that was evaluated.

        • ResourceId — (String)

          The ID of the AWS resource that was evaluated.

        • Compliance — (map)

          Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.

          • ComplianceType — (String)

            Indicates whether an AWS resource or AWS Config rule is compliant.

            A resource is compliant if it complies with all of the AWS Config rules that evaluate it, and it 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, and it is noncompliant if any of these resources do not comply.

            AWS Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the AWS resource or Config rule.

            For the Compliance data type, AWS Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. AWS 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 AWS resources or AWS Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

            • CappedCount — (Integer)

              The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.

Examples:

Calling the describeConfigRuleEvaluationStatus operation

var params = {
  ConfigRuleNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 0,
  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 AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config 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 50 rules.

      For more information about requesting a rule limit increase, see AWS Config Limits in the AWS 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 AWS managed Config rules.

        • ConfigRuleName — (String)

          The name of the AWS Config rule.

        • ConfigRuleArn — (String)

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

        • ConfigRuleId — (String)

          The ID of the AWS Config rule.

        • LastSuccessfulInvocationTime — (Date)

          The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources.

        • LastFailedInvocationTime — (Date)

          The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources.

        • LastSuccessfulEvaluationTime — (Date)

          The time that AWS Config last successfully evaluated your AWS resources against the rule.

        • LastFailedEvaluationTime — (Date)

          The time that AWS Config last failed to evaluate your AWS resources against the rule.

        • FirstActivatedTime — (Date)

          The time that you first activated the AWS Config rule.

        • LastErrorCode — (String)

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

        • LastErrorMessage — (String)

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

        • FirstEvaluationStarted — (Boolean)

          Indicates whether AWS Config has evaluated your resources against the rule at least once.

          • true - AWS Config has evaluated your AWS resources against the rule at least once.

          • false - AWS Config has not once finished evaluating your AWS resources against the rule.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Returns details about your AWS Config rules.

Service Reference:

Examples:

Calling the describeConfigRules operation

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

Parameters:

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

      The names of the AWS Config rules for which you want details. If you do not specify any names, AWS 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 AWS Config rules.

        • ConfigRuleName — (String)

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

        • ConfigRuleArn — (String)

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

        • ConfigRuleId — (String)

          The ID of the AWS Config rule.

        • Description — (String)

          The description that you provide for the AWS 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.

          • ComplianceResourceTypes — (Array<String>)

            The resource types of only those AWS 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 AWS resources that you want you want to trigger an evaluation for the rule.

          • TagValue — (String)

            The tag value applied to only those AWS 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 IDs of the only AWS 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.

        • Sourcerequired — (map)

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

          • Ownerrequired — (String)

            Indicates whether AWS or the customer owns and manages the AWS Config rule.

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

            For AWS 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 AWS Managed Config Rules.

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

          • SourceDetails — (Array<map>)

            Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.

            • EventSource — (String)

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

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

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

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

              • OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS 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 AWS Config delivers a configuration snapshot.

              If you want your custom rule to be triggered by configuration changes, specify both ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.

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

              The frequency that you want AWS 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.
              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 AWS Config rule Lambda function.

        • MaximumExecutionFrequency — (String)

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

          • You are using an AWS managed rule that is triggered at a periodic frequency.

          • Your custom rule is triggered when AWS 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 AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the Config rule.

          AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

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

          AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS 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"
      • 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.

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

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

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

Service Reference:

Examples:

Calling the describeConfigurationRecorders operation

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

Parameters:

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

      A list of configuration recorder names.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ConfigurationRecorders — (Array<map>)

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

        • name — (String)

          The name of the recorder. By default, AWS 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 AWS resources associated with the account.

        • recordingGroup — (map)

          Specifies the types of AWS resource for which AWS Config records configuration changes.

          • allSupported — (Boolean)

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

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

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

          • includeGlobalResourceTypes — (Boolean)

            Specifies whether AWS 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 AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

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

          • resourceTypes — (Array<String>)

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

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

            If you set this option to true, when AWS 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 AWS Resource Types.

Returns:

  • (AWS.Request)

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

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

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

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

Examples:

Calling the describeConfigurationRecorderStatus operation

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

Parameters:

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

      The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ConfigurationRecordersStatus — (Array<map>)

        A list that contains status of the specified recorders.

        • name — (String)

          The name of the configuration recorder.

        • lastStartTime — (Date)

          The time the recorder was last started.

        • lastStopTime — (Date)

          The time the recorder was last stopped.

        • recording — (Boolean)

          Specifies whether the recorder is currently recording or not.

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

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

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

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

Service Reference:

Examples:

Calling the describeDeliveryChannels operation

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

Parameters:

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

      A list of delivery channel names.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DeliveryChannels — (Array<map>)

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

        • name — (String)

          The name of the delivery channel. By default, AWS 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 AWS Config delivers configuration snapshots and configuration history files.

          If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon S3 Bucket in the AWS Config Developer Guide.

        • s3KeyPrefix — (String)

          The prefix for the specified Amazon S3 bucket.

        • snsTopicARN — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.

          If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon SNS Topic in the AWS Config Developer Guide.

        • configSnapshotDeliveryProperties — (map)

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

          • deliveryFrequency — (String)

            The frequency with which AWS Config delivers configuration snapshots.

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

Returns:

  • (AWS.Request)

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

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

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

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

Service Reference:

Examples:

Calling the describeDeliveryChannelStatus operation

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

Parameters:

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

      A list of delivery channel names.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DeliveryChannelsStatus — (Array<map>)

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

        • name — (String)

          The name of the delivery channel.

        • configSnapshotDeliveryInfo — (map)

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

          • lastStatus — (String)

            Status of the last attempted delivery.

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

            The error code from the last attempted delivery.

          • lastErrorMessage — (String)

            The error message from the last attempted delivery.

          • lastAttemptTime — (Date)

            The time of the last attempted delivery.

          • lastSuccessfulTime — (Date)

            The time of the last successful delivery.

          • nextDeliveryTime — (Date)

            The time that the next delivery occurs.

        • configHistoryDeliveryInfo — (map)

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

          • lastStatus — (String)

            Status of the last attempted delivery.

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

            The error code from the last attempted delivery.

          • lastErrorMessage — (String)

            The error message from the last attempted delivery.

          • lastAttemptTime — (Date)

            The time of the last attempted delivery.

          • lastSuccessfulTime — (Date)

            The time of the last successful delivery.

          • nextDeliveryTime — (Date)

            The time that the next delivery occurs.

        • configStreamDeliveryInfo — (map)

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

          • lastStatus — (String)

            Status of the last attempted delivery.

            Note Providing an SNS topic on a DeliveryChannel for AWS 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.

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

Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

Examples:

Calling the getComplianceDetailsByConfigRule operation

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

Parameters:

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

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

    • ComplianceTypes — (Array<String>)

      Filters the results by compliance.

      The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

    • Limit — (Integer)

      The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

    • NextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • EvaluationResults — (Array<map>)

        Indicates whether the AWS resource complies with the specified AWS Config rule.

        • EvaluationResultIdentifier — (map)

          Uniquely identifies the evaluation result.

          • EvaluationResultQualifier — (map)

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

            • ConfigRuleName — (String)

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

            • ResourceType — (String)

              The type of AWS resource that was evaluated.

            • ResourceId — (String)

              The ID of the evaluated AWS resource.

          • OrderingTimestamp — (Date)

            The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config delivered a configuration item change notification, or it can indicate when AWS Config delivered the configuration snapshot, depending on which event triggered the evaluation.

        • ComplianceType — (String)

          Indicates whether the AWS resource complies with the AWS Config rule that evaluated it.

          For the EvaluationResult data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

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

          The time when AWS Config recorded the evaluation result.

        • ConfigRuleInvokedTime — (Date)

          The time when the AWS Config rule evaluated the AWS resource.

        • Annotation — (String)

          Supplementary information about how the evaluation determined the compliance.

        • ResultToken — (String)

          An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS resource being evaluated, and the event that triggered the evaluation.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.

Service Reference:

Examples:

Calling the getComplianceDetailsByResource operation

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

Parameters:

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

      The type of the AWS resource for which you want compliance information.

    • ResourceId — (String)

      The ID of the AWS resource for which you want compliance information.

    • ComplianceTypes — (Array<String>)

      Filters the results by compliance.

      The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

    • NextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • EvaluationResults — (Array<map>)

        Indicates whether the specified AWS resource complies each AWS Config rule.

        • EvaluationResultIdentifier — (map)

          Uniquely identifies the evaluation result.

          • EvaluationResultQualifier — (map)

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

            • ConfigRuleName — (String)

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

            • ResourceType — (String)

              The type of AWS resource that was evaluated.

            • ResourceId — (String)

              The ID of the evaluated AWS resource.

          • OrderingTimestamp — (Date)

            The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config delivered a configuration item change notification, or it can indicate when AWS Config delivered the configuration snapshot, depending on which event triggered the evaluation.

        • ComplianceType — (String)

          Indicates whether the AWS resource complies with the AWS Config rule that evaluated it.

          For the EvaluationResult data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

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

          The time when AWS Config recorded the evaluation result.

        • ConfigRuleInvokedTime — (Date)

          The time when the AWS Config rule evaluated the AWS resource.

        • Annotation — (String)

          Supplementary information about how the evaluation determined the compliance.

        • ResultToken — (String)

          An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS resource being evaluated, and the event that triggered the evaluation.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

Examples:

Calling the getComplianceSummaryByConfigRule operation

configservice.getComplianceSummaryByConfigRule(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ComplianceSummary — (map)

        The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

        • CompliantResourceCount — (map)

          The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

          • CappedCount — (Integer)

            The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

          • CapExceeded — (Boolean)

            Indicates whether the maximum count is reached.

        • NonCompliantResourceCount — (map)

          The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

          • CappedCount — (Integer)

            The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

          • CapExceeded — (Boolean)

            Indicates whether the maximum count is reached.

        • ComplianceSummaryTimestamp — (Date)

          The time that AWS Config created the compliance summary.

Returns:

  • (AWS.Request)

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

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

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

Examples:

Calling the getComplianceSummaryByResourceType operation

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

Parameters:

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

      Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

      For this request, you can specify an AWS resource type such as AWS::EC2::Instance, and you can specify that the resource type is an AWS account by specifying AWS::::Account.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ComplianceSummariesByResourceType — (Array<map>)

        The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.

        • ResourceType — (String)

          The type of AWS resource.

        • ComplianceSummary — (map)

          The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each compliance.

          • CompliantResourceCount — (map)

            The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

            • CappedCount — (Integer)

              The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

          • NonCompliantResourceCount — (map)

            The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

            • CappedCount — (Integer)

              The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

            • CapExceeded — (Boolean)

              Indicates whether the maximum count is reached.

          • ComplianceSummaryTimestamp — (Date)

            The time that AWS Config created the compliance summary.

Returns:

  • (AWS.Request)

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

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

Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval.

The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

Note: Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

Service Reference:

Examples:

Calling the getResourceConfigHistory operation

var params = {
  resourceId: 'STRING_VALUE', /* required */
  resourceType: AWS::EC2::CustomerGateway | AWS::EC2::EIP | AWS::EC2::Host | AWS::EC2::Instance | AWS::EC2::InternetGateway | AWS::EC2::NetworkAcl | AWS::EC2::NetworkInterface | AWS::EC2::RouteTable | AWS::EC2::SecurityGroup | AWS::EC2::Subnet | AWS::CloudTrail::Trail | AWS::EC2::Volume | AWS::EC2::VPC | AWS::EC2::VPNConnection | AWS::EC2::VPNGateway | AWS::IAM::Group | AWS::IAM::Policy | AWS::IAM::Role | AWS::IAM::User | AWS::ACM::Certificate | AWS::RDS::DBInstance | AWS::RDS::DBSubnetGroup | AWS::RDS::DBSecurityGroup | AWS::RDS::DBSnapshot | AWS::RDS::EventSubscription | AWS::ElasticLoadBalancingV2::LoadBalancer | AWS::S3::Bucket | AWS::SSM::ManagedInstanceInventory | AWS::Redshift::Cluster | AWS::Redshift::ClusterSnapshot | AWS::Redshift::ClusterParameterGroup | AWS::Redshift::ClusterSecurityGroup | AWS::Redshift::ClusterSubnetGroup | AWS::Redshift::EventSubscription | AWS::CloudWatch::Alarm, /* required */
  chronologicalOrder: Reverse | Forward,
  earlierTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  laterTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  limit: 0,
  nextToken: 'STRING_VALUE'
};
configservice.getResourceConfigHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The resource type.

      Possible values include:
      • "AWS::EC2::CustomerGateway"
      • "AWS::EC2::EIP"
      • "AWS::EC2::Host"
      • "AWS::EC2::Instance"
      • "AWS::EC2::InternetGateway"
      • "AWS::EC2::NetworkAcl"
      • "AWS::EC2::NetworkInterface"
      • "AWS::EC2::RouteTable"
      • "AWS::EC2::SecurityGroup"
      • "AWS::EC2::Subnet"
      • "AWS::CloudTrail::Trail"
      • "AWS::EC2::Volume"
      • "AWS::EC2::VPC"
      • "AWS::EC2::VPNConnection"
      • "AWS::EC2::VPNGateway"
      • "AWS::IAM::Group"
      • "AWS::IAM::Policy"
      • "AWS::IAM::Role"
      • "AWS::IAM::User"
      • "AWS::ACM::Certificate"
      • "AWS::RDS::DBInstance"
      • "AWS::RDS::DBSubnetGroup"
      • "AWS::RDS::DBSecurityGroup"
      • "AWS::RDS::DBSnapshot"
      • "AWS::RDS::EventSubscription"
      • "AWS::ElasticLoadBalancingV2::LoadBalancer"
      • "AWS::S3::Bucket"
      • "AWS::SSM::ManagedInstanceInventory"
      • "AWS::Redshift::Cluster"
      • "AWS::Redshift::ClusterSnapshot"
      • "AWS::Redshift::ClusterParameterGroup"
      • "AWS::Redshift::ClusterSecurityGroup"
      • "AWS::Redshift::ClusterSubnetGroup"
      • "AWS::Redshift::EventSubscription"
      • "AWS::CloudWatch::Alarm"
    • resourceId — (String)

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

    • laterTime — (Date)

      The time stamp that indicates a later time. If not specified, current time is taken.

    • earlierTime — (Date)

      The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start from when the first configuration item was recorded.

    • chronologicalOrder — (String)

      The chronological order for configuration items listed. By default the results are listed in reverse chronological order.

      Possible values include:
      • "Reverse"
      • "Forward"
    • limit — (Integer)

      The maximum number of configuration items returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

    • nextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • configurationItems — (Array<map>)

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

        • version — (String)

          The version number of the resource configuration.

        • accountId — (String)

          The 12 digit AWS account ID associated with the resource.

        • configurationItemCaptureTime — (Date)

          The time when the configuration recording was initiated.

        • configurationItemStatus — (String)

          The configuration item status.

          Possible values include:
          • "Ok"
          • "Failed"
          • "Discovered"
          • "Deleted"
        • configurationStateId — (String)

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

        • configurationItemMD5Hash — (String)

          Unique MD5 hash that represents the configuration item's state.

          You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

        • arn — (String)

          The Amazon Resource Name (ARN) of the resource.

        • resourceType — (String)

          The type of AWS 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::IAM::Group"
          • "AWS::IAM::Policy"
          • "AWS::IAM::Role"
          • "AWS::IAM::User"
          • "AWS::ACM::Certificate"
          • "AWS::RDS::DBInstance"
          • "AWS::RDS::DBSubnetGroup"
          • "AWS::RDS::DBSecurityGroup"
          • "AWS::RDS::DBSnapshot"
          • "AWS::RDS::EventSubscription"
          • "AWS::ElasticLoadBalancingV2::LoadBalancer"
          • "AWS::S3::Bucket"
          • "AWS::SSM::ManagedInstanceInventory"
          • "AWS::Redshift::Cluster"
          • "AWS::Redshift::ClusterSnapshot"
          • "AWS::Redshift::ClusterParameterGroup"
          • "AWS::Redshift::ClusterSecurityGroup"
          • "AWS::Redshift::ClusterSubnetGroup"
          • "AWS::Redshift::EventSubscription"
          • "AWS::CloudWatch::Alarm"
        • resourceId — (String)

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

        • resourceName — (String)

          The custom name of the resource, if available.

        • awsRegion — (String)

          The region where the resource resides.

        • availabilityZone — (String)

          The Availability Zone associated with the resource.

        • resourceCreationTime — (Date)

          The time stamp when the resource was created.

        • tags — (map<String>)

          A mapping of key value tags associated with the resource.

        • relatedEvents — (Array<String>)

          A list of CloudTrail event IDs.

          A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What is AWS CloudTrail?.

          An empty field indicates that the current configuration was not initiated by any event.

        • relationships — (Array<map>)

          A list of related AWS resources.

          • resourceType — (String)

            The resource type of the related resource.

            Possible values include:
            • "AWS::EC2::CustomerGateway"
            • "AWS::EC2::EIP"
            • "AWS::EC2::Host"
            • "AWS::EC2::Instance"
            • "AWS::EC2::InternetGateway"
            • "AWS::EC2::NetworkAcl"
            • "AWS::EC2::NetworkInterface"
            • "AWS::EC2::RouteTable"
            • "AWS::EC2::SecurityGroup"
            • "AWS::EC2::Subnet"
            • "AWS::CloudTrail::Trail"
            • "AWS::EC2::Volume"
            • "AWS::EC2::VPC"
            • "AWS::EC2::VPNConnection"
            • "AWS::EC2::VPNGateway"
            • "AWS::IAM::Group"
            • "AWS::IAM::Policy"
            • "AWS::IAM::Role"
            • "AWS::IAM::User"
            • "AWS::ACM::Certificate"
            • "AWS::RDS::DBInstance"
            • "AWS::RDS::DBSubnetGroup"
            • "AWS::RDS::DBSecurityGroup"
            • "AWS::RDS::DBSnapshot"
            • "AWS::RDS::EventSubscription"
            • "AWS::ElasticLoadBalancingV2::LoadBalancer"
            • "AWS::S3::Bucket"
            • "AWS::SSM::ManagedInstanceInventory"
            • "AWS::Redshift::Cluster"
            • "AWS::Redshift::ClusterSnapshot"
            • "AWS::Redshift::ClusterParameterGroup"
            • "AWS::Redshift::ClusterSecurityGroup"
            • "AWS::Redshift::ClusterSubnetGroup"
            • "AWS::Redshift::EventSubscription"
            • "AWS::CloudWatch::Alarm"
          • resourceId — (String)

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

          • resourceName — (String)

            The custom name of the related resource, if available.

          • relationshipName — (String)

            The type of relationship with the related resource.

        • configuration — (String)

          The description of the resource configuration.

        • supplementaryConfiguration — (map<String>)

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

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

Note: You can specify either resource IDs or a resource name but not both in the same request.

The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

Service Reference:

Examples:

Calling the listDiscoveredResources operation

var params = {
  resourceType: AWS::EC2::CustomerGateway | AWS::EC2::EIP | AWS::EC2::Host | AWS::EC2::Instance | AWS::EC2::InternetGateway | AWS::EC2::NetworkAcl | AWS::EC2::NetworkInterface | AWS::EC2::RouteTable | AWS::EC2::SecurityGroup | AWS::EC2::Subnet | AWS::CloudTrail::Trail | AWS::EC2::Volume | AWS::EC2::VPC | AWS::EC2::VPNConnection | AWS::EC2::VPNGateway | AWS::IAM::Group | AWS::IAM::Policy | AWS::IAM::Role | AWS::IAM::User | AWS::ACM::Certificate | AWS::RDS::DBInstance | AWS::RDS::DBSubnetGroup | AWS::RDS::DBSecurityGroup | AWS::RDS::DBSnapshot | AWS::RDS::EventSubscription | AWS::ElasticLoadBalancingV2::LoadBalancer | AWS::S3::Bucket | AWS::SSM::ManagedInstanceInventory | AWS::Redshift::Cluster | AWS::Redshift::ClusterSnapshot | AWS::Redshift::ClusterParameterGroup | AWS::Redshift::ClusterSecurityGroup | AWS::Redshift::ClusterSubnetGroup | AWS::Redshift::EventSubscription | AWS::CloudWatch::Alarm, /* required */
  includeDeletedResources: true || false,
  limit: 0,
  nextToken: 'STRING_VALUE',
  resourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  resourceName: 'STRING_VALUE'
};
configservice.listDiscoveredResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Possible values include:
      • "AWS::EC2::CustomerGateway"
      • "AWS::EC2::EIP"
      • "AWS::EC2::Host"
      • "AWS::EC2::Instance"
      • "AWS::EC2::InternetGateway"
      • "AWS::EC2::NetworkAcl"
      • "AWS::EC2::NetworkInterface"
      • "AWS::EC2::RouteTable"
      • "AWS::EC2::SecurityGroup"
      • "AWS::EC2::Subnet"
      • "AWS::CloudTrail::Trail"
      • "AWS::EC2::Volume"
      • "AWS::EC2::VPC"
      • "AWS::EC2::VPNConnection"
      • "AWS::EC2::VPNGateway"
      • "AWS::IAM::Group"
      • "AWS::IAM::Policy"
      • "AWS::IAM::Role"
      • "AWS::IAM::User"
      • "AWS::ACM::Certificate"
      • "AWS::RDS::DBInstance"
      • "AWS::RDS::DBSubnetGroup"
      • "AWS::RDS::DBSecurityGroup"
      • "AWS::RDS::DBSnapshot"
      • "AWS::RDS::EventSubscription"
      • "AWS::ElasticLoadBalancingV2::LoadBalancer"
      • "AWS::S3::Bucket"
      • "AWS::SSM::ManagedInstanceInventory"
      • "AWS::Redshift::Cluster"
      • "AWS::Redshift::ClusterSnapshot"
      • "AWS::Redshift::ClusterParameterGroup"
      • "AWS::Redshift::ClusterSecurityGroup"
      • "AWS::Redshift::ClusterSubnetGroup"
      • "AWS::Redshift::EventSubscription"
      • "AWS::CloudWatch::Alarm"
    • resourceIds — (Array<String>)

      The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

    • resourceName — (String)

      The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

    • limit — (Integer)

      The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

    • includeDeletedResources — (Boolean)

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

    • nextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • resourceIdentifiers — (Array<map>)

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

        • resourceType — (String)

          The type of resource.

          Possible values include:
          • "AWS::EC2::CustomerGateway"
          • "AWS::EC2::EIP"
          • "AWS::EC2::Host"
          • "AWS::EC2::Instance"
          • "AWS::EC2::InternetGateway"
          • "AWS::EC2::NetworkAcl"
          • "AWS::EC2::NetworkInterface"
          • "AWS::EC2::RouteTable"
          • "AWS::EC2::SecurityGroup"
          • "AWS::EC2::Subnet"
          • "AWS::CloudTrail::Trail"
          • "AWS::EC2::Volume"
          • "AWS::EC2::VPC"
          • "AWS::EC2::VPNConnection"
          • "AWS::EC2::VPNGateway"
          • "AWS::IAM::Group"
          • "AWS::IAM::Policy"
          • "AWS::IAM::Role"
          • "AWS::IAM::User"
          • "AWS::ACM::Certificate"
          • "AWS::RDS::DBInstance"
          • "AWS::RDS::DBSubnetGroup"
          • "AWS::RDS::DBSecurityGroup"
          • "AWS::RDS::DBSnapshot"
          • "AWS::RDS::EventSubscription"
          • "AWS::ElasticLoadBalancingV2::LoadBalancer"
          • "AWS::S3::Bucket"
          • "AWS::SSM::ManagedInstanceInventory"
          • "AWS::Redshift::Cluster"
          • "AWS::Redshift::ClusterSnapshot"
          • "AWS::Redshift::ClusterParameterGroup"
          • "AWS::Redshift::ClusterSecurityGroup"
          • "AWS::Redshift::ClusterSubnetGroup"
          • "AWS::Redshift::EventSubscription"
          • "AWS::CloudWatch::Alarm"
        • resourceId — (String)

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

        • resourceName — (String)

          The custom name of the resource (if available).

        • resourceDeletionTime — (Date)

          The time that the resource was deleted.

      • nextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.

You can use this action for custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.

If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config Rules.

For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules.

If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

The maximum number of rules that AWS Config supports is 50.

For more information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

Service Reference:

Examples:

Calling the putConfigRule operation

var params = {
  ConfigRule: { /* required */
    Source: { /* required */
      Owner: CUSTOM_LAMBDA | AWS, /* required */
      SourceIdentifier: 'STRING_VALUE', /* required */
      SourceDetails: [
        {
          EventSource: aws.config,
          MaximumExecutionFrequency: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours,
          MessageType: ConfigurationItemChangeNotification | ConfigurationSnapshotDeliveryCompleted | ScheduledNotification | OversizedConfigurationItemChangeNotification
        },
        /* more items */
      ]
    },
    ConfigRuleArn: 'STRING_VALUE',
    ConfigRuleId: 'STRING_VALUE',
    ConfigRuleName: 'STRING_VALUE',
    ConfigRuleState: ACTIVE | DELETING | DELETING_RESULTS | EVALUATING,
    Description: 'STRING_VALUE',
    InputParameters: 'STRING_VALUE',
    MaximumExecutionFrequency: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours,
    Scope: {
      ComplianceResourceId: 'STRING_VALUE',
      ComplianceResourceTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      TagKey: 'STRING_VALUE',
      TagValue: 'STRING_VALUE'
    }
  }
};
configservice.putConfigRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigRule — (map)

      The rule that you want to add to your account.

      • ConfigRuleName — (String)

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

      • ConfigRuleArn — (String)

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

      • ConfigRuleId — (String)

        The ID of the AWS Config rule.

      • Description — (String)

        The description that you provide for the AWS 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.

        • ComplianceResourceTypes — (Array<String>)

          The resource types of only those AWS 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 AWS resources that you want you want to trigger an evaluation for the rule.

        • TagValue — (String)

          The tag value applied to only those AWS 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 IDs of the only AWS 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.

      • Sourcerequired — (map)

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

        • Ownerrequired — (String)

          Indicates whether AWS or the customer owns and manages the AWS Config rule.

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

          For AWS 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 AWS Managed Config Rules.

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

        • SourceDetails — (Array<map>)

          Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.

          • EventSource — (String)

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

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

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

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

            • OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS 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 AWS Config delivers a configuration snapshot.

            If you want your custom rule to be triggered by configuration changes, specify both ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.

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

            The frequency that you want AWS 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.
            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 AWS Config rule Lambda function.

      • MaximumExecutionFrequency — (String)

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

        • You are using an AWS managed rule that is triggered at a periodic frequency.

        • Your custom rule is triggered when AWS 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 AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the Config rule.

        AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

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

        AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS 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"

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.

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

Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN and/or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Note: Currently, you can specify only one configuration recorder per region in your account. If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Service Reference:

Examples:

Calling the putConfigurationRecorder operation

var params = {
  ConfigurationRecorder: { /* required */
    name: 'STRING_VALUE',
    recordingGroup: {
      allSupported: true || false,
      includeGlobalResourceTypes: true || false,
      resourceTypes: [
        AWS::EC2::CustomerGateway | AWS::EC2::EIP | AWS::EC2::Host | AWS::EC2::Instance | AWS::EC2::InternetGateway | AWS::EC2::NetworkAcl | AWS::EC2::NetworkInterface | AWS::EC2::RouteTable | AWS::EC2::SecurityGroup | AWS::EC2::Subnet | AWS::CloudTrail::Trail | AWS::EC2::Volume | AWS::EC2::VPC | AWS::EC2::VPNConnection | AWS::EC2::VPNGateway | AWS::IAM::Group | AWS::IAM::Policy | AWS::IAM::Role | AWS::IAM::User | AWS::ACM::Certificate | AWS::RDS::DBInstance | AWS::RDS::DBSubnetGroup | AWS::RDS::DBSecurityGroup | AWS::RDS::DBSnapshot | AWS::RDS::EventSubscription | AWS::ElasticLoadBalancingV2::LoadBalancer | AWS::S3::Bucket | AWS::SSM::ManagedInstanceInventory | AWS::Redshift::Cluster | AWS::Redshift::ClusterSnapshot | AWS::Redshift::ClusterParameterGroup | AWS::Redshift::ClusterSecurityGroup | AWS::Redshift::ClusterSubnetGroup | AWS::Redshift::EventSubscription | AWS::CloudWatch::Alarm,
        /* more items */
      ]
    },
    roleARN: 'STRING_VALUE'
  }
};
configservice.putConfigurationRecorder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationRecorder — (map)

      The configuration recorder object that records each configuration change made to the resources.

      • name — (String)

        The name of the recorder. By default, AWS 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 AWS resources associated with the account.

      • recordingGroup — (map)

        Specifies the types of AWS resource for which AWS Config records configuration changes.

        • allSupported — (Boolean)

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

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

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

        • includeGlobalResourceTypes — (Boolean)

          Specifies whether AWS 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 AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

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

        • resourceTypes — (Array<String>)

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

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

          If you set this option to true, when AWS 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 AWS Resource Types.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.

Before you can create a delivery channel, you must create a configuration recorder.

You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

Note: You can have only one delivery channel per region in your account.

Service Reference:

Examples:

Calling the putDeliveryChannel operation

var params = {
  DeliveryChannel: { /* required */
    configSnapshotDeliveryProperties: {
      deliveryFrequency: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours
    },
    name: 'STRING_VALUE',
    s3BucketName: 'STRING_VALUE',
    s3KeyPrefix: 'STRING_VALUE',
    snsTopicARN: 'STRING_VALUE'
  }
};
configservice.putDeliveryChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeliveryChannel — (map)

      The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.

      • name — (String)

        The name of the delivery channel. By default, AWS 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 AWS Config delivers configuration snapshots and configuration history files.

        If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon S3 Bucket in the AWS Config Developer Guide.

      • s3KeyPrefix — (String)

        The prefix for the specified Amazon S3 bucket.

      • snsTopicARN — (String)

        The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.

        If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon SNS Topic in the AWS Config Developer Guide.

      • configSnapshotDeliveryProperties — (map)

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

        • deliveryFrequency — (String)

          The frequency with which AWS Config delivers configuration snapshots.

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.

Service Reference:

Examples:

Calling the putEvaluations operation

var params = {
  ResultToken: 'STRING_VALUE', /* required */
  Evaluations: [
    {
      ComplianceResourceId: 'STRING_VALUE', /* required */
      ComplianceResourceType: 'STRING_VALUE', /* required */
      ComplianceType: COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA, /* required */
      OrderingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      Annotation: 'STRING_VALUE'
    },
    /* more items */
  ],
  TestMode: true || false
};
configservice.putEvaluations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.

      • ComplianceResourceTyperequired — (String)

        The type of AWS resource that was evaluated.

      • ComplianceResourceIdrequired — (String)

        The ID of the AWS resource that was evaluated.

      • ComplianceTyperequired — (String)

        Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

        For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

        Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

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

        Supplementary information about how the evaluation determined the compliance.

      • OrderingTimestamprequired — (Date)

        The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

    • ResultToken — (String)

      An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation

    • TestMode — (Boolean)

      Use this parameter to specify a test run for PutEvaluations. You can verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config.

      Note: When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • FailedEvaluations — (Array<map>)

        Requests that failed because of a client or server error.

        • ComplianceResourceTyperequired — (String)

          The type of AWS resource that was evaluated.

        • ComplianceResourceIdrequired — (String)

          The ID of the AWS resource that was evaluated.

        • ComplianceTyperequired — (String)

          Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

          For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

          Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

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

          Supplementary information about how the evaluation determined the compliance.

        • OrderingTimestamprequired — (Date)

          The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

Returns:

  • (AWS.Request)

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

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

Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test a rule that you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources; it re-runs an evaluation against the last known state of your resources.

You can specify up to 25 Config rules per request.

An existing StartConfigRulesEvaluation call must complete for the specified rules before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

Note: You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a new rule, AWS Config automatically evaluates your resources against the rule.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. AWS Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

Service Reference:

Examples:

Calling the startConfigRulesEvaluation operation

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

Parameters:

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

      The list of names of Config rules that you want to run evaluations for.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Starts recording configurations of the AWS resources you have selected to record in your AWS account.

You must have created at least one delivery channel to successfully start the configuration recorder.

Service Reference:

Examples:

Calling the startConfigurationRecorder operation

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

Parameters:

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

      The name of the recorder object that records each configuration change made to the resources.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Service Reference:

Examples:

Calling the stopConfigurationRecorder operation

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

Parameters:

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

      The name of the recorder object that records each configuration change made to the resources.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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