@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 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

$3

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 ListImportsCommand:

``js
// ES5 example
const { CloudTrailClient, ListImportsCommand } = require("@aws-sdk/client-cloudtrail");
`

`ts
// ES6+ example
import { CloudTrailClient, ListImportsCommand } from "@aws-sdk/client-cloudtrail";
`

$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 CloudTrailClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListImportsCommand(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-cloudtrail";
const client = new AWS.CloudTrail({ region: "REGION" });

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

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

// callbacks.
client.listImports(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-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.

Client Commands (Operations List)

AddTags

Command API Reference / Input / Output

CancelQuery

Command API Reference / Input / Output

CreateChannel

Command API Reference / Input / Output

CreateDashboard

Command API Reference / Input / Output

CreateEventDataStore

Command API Reference / Input / Output

CreateTrail

Command API Reference / Input / Output

DeleteChannel

Command API Reference / Input / Output

DeleteDashboard

Command API Reference / Input / Output

DeleteEventDataStore

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DeleteTrail

Command API Reference / Input / Output

DeregisterOrganizationDelegatedAdmin

Command API Reference / Input / Output

DescribeQuery

Command API Reference / Input / Output

DescribeTrails

Command API Reference / Input / Output

DisableFederation

Command API Reference / Input / Output

EnableFederation

Command API Reference / Input / Output

GenerateQuery

Command API Reference / Input / Output

GetChannel

Command API Reference / Input / Output

GetDashboard

Command API Reference / Input / Output

GetEventConfiguration

Command API Reference / Input / Output

GetEventDataStore

Command API Reference / Input / Output

GetEventSelectors

Command API Reference / Input / Output

GetImport

Command API Reference / Input / Output

GetInsightSelectors

Command API Reference / Input / Output

GetQueryResults

Command API Reference / Input / Output

GetResourcePolicy

Command API Reference / Input / Output

GetTrail

Command API Reference / Input / Output

GetTrailStatus

Command API Reference / Input / Output

ListChannels

Command API Reference / Input / Output

ListDashboards

Command API Reference / Input / Output

ListEventDataStores

Command API Reference / Input / Output

ListImportFailures

Command API Reference / Input / Output

ListImports

Command API Reference / Input / Output

ListInsightsData

Command API Reference / Input / Output

ListInsightsMetricData

Command API Reference / Input / Output

ListPublicKeys

Command API Reference / Input / Output

ListQueries

Command API Reference / Input / Output

ListTags

Command API Reference / Input / Output

ListTrails

Command API Reference / Input / Output

LookupEvents

Command API Reference / Input / Output

PutEventConfiguration

Command API Reference / Input / Output

PutEventSelectors

Command API Reference / Input / Output

PutInsightSelectors

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

RegisterOrganizationDelegatedAdmin

Command API Reference / Input / Output

RemoveTags

Command API Reference / Input / Output

RestoreEventDataStore

Command API Reference / Input / Output

SearchSampleQueries

Command API Reference / Input / Output

StartDashboardRefresh

Command API Reference / Input / Output

StartEventDataStoreIngestion

Command API Reference / Input / Output

StartImport

Command API Reference / Input / Output

StartLogging

Command API Reference / Input / Output

StartQuery

Command API Reference / Input / Output

StopEventDataStoreIngestion

Command API Reference / Input / Output

StopImport

Command API Reference / Input / Output

StopLogging

Command API Reference / Input / Output

UpdateChannel

Command API Reference / Input / Output

UpdateDashboard

Command API Reference / Input / Output

UpdateEventDataStore

Command API Reference / Input / Output

UpdateTrail

Command API Reference / Input / Output