@aws-sdk/client-config-service

Description

AWS SDK for JavaScript ConfigService Client for Node.js, Browser and React Native.

Config

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

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

Installing

To install this package, simply type add or install @aws-sdk/client-config-service
using your favorite package manager:
- npm install @aws-sdk/client-config-service
- yarn add @aws-sdk/client-config-service
- pnpm add @aws-sdk/client-config-service

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ConfigServiceClient and
the commands you need, for example ListStoredQueriesCommand:

``js
// ES5 example
const { ConfigServiceClient, ListStoredQueriesCommand } = require("@aws-sdk/client-config-service");
`

`ts
// ES6+ example
import { ConfigServiceClient, ListStoredQueriesCommand } from "@aws-sdk/client-config-service";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new ConfigServiceClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListStoredQueriesCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-config-service";
const client = new AWS.ConfigService({ region: "REGION" });

// async/await.
try {
const data = await client.listStoredQueries(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listStoredQueries(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listStoredQueries(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-config-service` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AssociateResourceTypes

Command API Reference / Input / Output

BatchGetAggregateResourceConfig

Command API Reference / Input / Output

BatchGetResourceConfig

Command API Reference / Input / Output

DeleteAggregationAuthorization

Command API Reference / Input / Output

DeleteConfigRule

Command API Reference / Input / Output

DeleteConfigurationAggregator

Command API Reference / Input / Output

DeleteConfigurationRecorder

Command API Reference / Input / Output

DeleteConformancePack

Command API Reference / Input / Output

DeleteDeliveryChannel

Command API Reference / Input / Output

DeleteEvaluationResults

Command API Reference / Input / Output

DeleteOrganizationConfigRule

Command API Reference / Input / Output

DeleteOrganizationConformancePack

Command API Reference / Input / Output

DeletePendingAggregationRequest

Command API Reference / Input / Output

DeleteRemediationConfiguration

Command API Reference / Input / Output

DeleteRemediationExceptions

Command API Reference / Input / Output

DeleteResourceConfig

Command API Reference / Input / Output

DeleteRetentionConfiguration

Command API Reference / Input / Output

DeleteServiceLinkedConfigurationRecorder

Command API Reference / Input / Output

DeleteStoredQuery

Command API Reference / Input / Output

DeliverConfigSnapshot

Command API Reference / Input / Output

DescribeAggregateComplianceByConfigRules

Command API Reference / Input / Output

DescribeAggregateComplianceByConformancePacks

Command API Reference / Input / Output

DescribeAggregationAuthorizations

Command API Reference / Input / Output

DescribeComplianceByConfigRule

Command API Reference / Input / Output

DescribeComplianceByResource

Command API Reference / Input / Output

DescribeConfigRuleEvaluationStatus

Command API Reference / Input / Output

DescribeConfigRules

Command API Reference / Input / Output

DescribeConfigurationAggregators

Command API Reference / Input / Output

DescribeConfigurationAggregatorSourcesStatus

Command API Reference / Input / Output

DescribeConfigurationRecorders

Command API Reference / Input / Output

DescribeConfigurationRecorderStatus

Command API Reference / Input / Output

DescribeConformancePackCompliance

Command API Reference / Input / Output

DescribeConformancePacks

Command API Reference / Input / Output

DescribeConformancePackStatus

Command API Reference / Input / Output

DescribeDeliveryChannels

Command API Reference / Input / Output

DescribeDeliveryChannelStatus

Command API Reference / Input / Output

DescribeOrganizationConfigRules

Command API Reference / Input / Output

DescribeOrganizationConfigRuleStatuses

Command API Reference / Input / Output

DescribeOrganizationConformancePacks

Command API Reference / Input / Output

DescribeOrganizationConformancePackStatuses

Command API Reference / Input / Output

DescribePendingAggregationRequests

Command API Reference / Input / Output

DescribeRemediationConfigurations

Command API Reference / Input / Output

DescribeRemediationExceptions

Command API Reference / Input / Output

DescribeRemediationExecutionStatus

Command API Reference / Input / Output

DescribeRetentionConfigurations

Command API Reference / Input / Output

DisassociateResourceTypes

Command API Reference / Input / Output

GetAggregateComplianceDetailsByConfigRule

Command API Reference / Input / Output

GetAggregateConfigRuleComplianceSummary

Command API Reference / Input / Output

GetAggregateConformancePackComplianceSummary

Command API Reference / Input / Output

GetAggregateDiscoveredResourceCounts

Command API Reference / Input / Output

GetAggregateResourceConfig

Command API Reference / Input / Output

GetComplianceDetailsByConfigRule

Command API Reference / Input / Output

GetComplianceDetailsByResource

Command API Reference / Input / Output

GetComplianceSummaryByConfigRule

Command API Reference / Input / Output

GetComplianceSummaryByResourceType

Command API Reference / Input / Output

GetConformancePackComplianceDetails

Command API Reference / Input / Output

GetConformancePackComplianceSummary

Command API Reference / Input / Output

GetCustomRulePolicy

Command API Reference / Input / Output

GetDiscoveredResourceCounts

Command API Reference / Input / Output

GetOrganizationConfigRuleDetailedStatus

Command API Reference / Input / Output

GetOrganizationConformancePackDetailedStatus

Command API Reference / Input / Output

GetOrganizationCustomRulePolicy

Command API Reference / Input / Output

GetResourceConfigHistory

Command API Reference / Input / Output

GetResourceEvaluationSummary

Command API Reference / Input / Output

GetStoredQuery

Command API Reference / Input / Output

ListAggregateDiscoveredResources

Command API Reference / Input / Output

ListConfigurationRecorders

Command API Reference / Input / Output

ListConformancePackComplianceScores

Command API Reference / Input / Output

ListDiscoveredResources

Command API Reference / Input / Output

ListResourceEvaluations

Command API Reference / Input / Output

ListStoredQueries

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutAggregationAuthorization

Command API Reference / Input / Output

PutConfigRule

Command API Reference / Input / Output

PutConfigurationAggregator

Command API Reference / Input / Output

PutConfigurationRecorder

Command API Reference / Input / Output

PutConformancePack

Command API Reference / Input / Output

PutDeliveryChannel

Command API Reference / Input / Output

PutEvaluations

Command API Reference / Input / Output

PutExternalEvaluation

Command API Reference / Input / Output

PutOrganizationConfigRule

Command API Reference / Input / Output

PutOrganizationConformancePack

Command API Reference / Input / Output

PutRemediationConfigurations

Command API Reference / Input / Output

PutRemediationExceptions

Command API Reference / Input / Output

PutResourceConfig

Command API Reference / Input / Output

PutRetentionConfiguration

Command API Reference / Input / Output

PutServiceLinkedConfigurationRecorder

Command API Reference / Input / Output

PutStoredQuery

Command API Reference / Input / Output

SelectAggregateResourceConfig

Command API Reference / Input / Output

SelectResourceConfig

Command API Reference / Input / Output

StartConfigRulesEvaluation

Command API Reference / Input / Output

StartConfigurationRecorder

Command API Reference / Input / Output

StartRemediationExecution

Command API Reference / Input / Output

StartResourceEvaluation

Command API Reference / Input / Output

StopConfigurationRecorder

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output