This package has been deprecated

Author message:

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

@aws-sdk/client-cloudtrail-browser

Description

AWS CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

Installing

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

npm install @aws-sdk/client-cloudtrail-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(CloudTrailClient) and the commands you need, for example AddTagsCommand:

//JavaScript
const {
  CloudTrailClient
} = require("@aws-sdk/client-cloudtrail-browser/CloudTrailClient");
const {
  AddTagsCommand
} = require("@aws-sdk/client-cloudtrail-browser/commands/AddTagsCommand");

//TypeScript
import { CloudTrailClient } from "@aws-sdk/client-cloudtrail-browser/CloudTrailClient";
import { AddTagsCommand } from "@aws-sdk/client-cloudtrail-browser/commands/AddTagsCommand";

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 cloudTrail = new CloudTrailClient({region: 'region'});
//clients can be shared by different commands
const params = {
  ResourceId: /**a string value*/,
};
const addTagsCommand = new AddTagsCommand(params);
cloudTrail.send(addTagsCommand).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 cloudTrail.send(addTagsCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
cloudTrail.send(addTagsCommand, (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-cloudtrail-browser/CloudTrail";
const cloudTrail = new AWS.CloudTrail({ region: "region" });
cloudTrail.addTags(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 cloudTrail.send(addTagsCommand);
  // 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-cloudtrail-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.