This package has been deprecated

Author message:

The package @aws-sdk/client-config-service-browser has been renamed to @aws-sdk/client-config-service. Please install the renamed package.

@aws-sdk/client-config-service-browser

Description

AWS Config

AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS 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 AWS Config, see Supported AWS Resources.

You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config. This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. The AWS 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 AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config in the AWS Config Developer Guide.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-config-service-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(ConfigServiceClient) and the commands you need, for example BatchGetAggregateResourceConfigCommand:

//JavaScript
const {
  ConfigServiceClient
} = require("@aws-sdk/client-config-service-browser/ConfigServiceClient");
const {
  BatchGetAggregateResourceConfigCommand
} = require("@aws-sdk/client-config-service-browser/commands/BatchGetAggregateResourceConfigCommand");

//TypeScript
import { ConfigServiceClient } from "@aws-sdk/client-config-service-browser/ConfigServiceClient";
import { BatchGetAggregateResourceConfigCommand } from "@aws-sdk/client-config-service-browser/commands/BatchGetAggregateResourceConfigCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const configService = new ConfigServiceClient({region: 'region'});
//clients can be shared by different commands
const params = {
  ConfigurationAggregatorName: /**a string value*/,
  ResourceIdentifiers: [ /**a list of structure*/ ],
};
const batchGetAggregateResourceConfigCommand = new BatchGetAggregateResourceConfigCommand(params);
configService.send(batchGetAggregateResourceConfigCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await configService.send(batchGetAggregateResourceConfigCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
configService.send(batchGetAggregateResourceConfigCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-config-service-browser/ConfigService";
const configService = new AWS.ConfigService({ region: "region" });
configService.batchGetAggregateResourceConfig(params, (err, data) => {
  //do something
});

Troubleshooting

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

try {
  const data = await configService.send(batchGetAggregateResourceConfigCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-config-service-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

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