@aws-sdk/client-cloudtrail
Description
AWS SDK for JavaScript CloudTrail Client for Node.js, Browser and React Native.
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 Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket.
The recorded information includes the identity of the user, the start time of the Amazon Web Services 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 Amazon Web Services SDKs, which consist of libraries and sample code for various
programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs
provide programmatic access to CloudTrail. For example, the SDKs
handle cryptographically signing requests, managing errors, and retrying requests
automatically. For more information about the Amazon Web Services SDKs, including how to download and install
them, see Tools to Build on Amazon Web Services.
See the CloudTrail User
Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
Installing
To install the this package, simply type add or install @aws-sdk/client-cloudtrail
using your favorite package manager:
npm install @aws-sdk/client-cloudtrail
yarn add @aws-sdk/client-cloudtrail
pnpm add @aws-sdk/client-cloudtrail
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the CloudTrailClient
and
the commands you need, for example AddTagsCommand
:
const { CloudTrailClient, AddTagsCommand } = require("@aws-sdk/client-cloudtrail");
import { CloudTrailClient, AddTagsCommand } from "@aws-sdk/client-cloudtrail";
Usage
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.
const client = new CloudTrailClient({ region: "REGION" });
const params = {
};
const command = new AddTagsCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} 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.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, 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
import * as AWS from "@aws-sdk/client-cloudtrail";
const client = new AWS.CloudTrail({ region: "REGION" });
try {
const data = await client.addTags(params);
} catch (error) {
}
client
.addTags(params)
.then((data) => {
})
.catch((error) => {
});
client.addTags(params, (err, data) => {
});
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 client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
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.
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-cloudtrail
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.