@aws-sdk/client-accessanalyzer

Description

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

Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external, internal, and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external, internal, or unused access, you first need to create an analyzer.

External access analyzers help you identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.

Internal access analyzers help you identify which principals within your organization or account have access to selected resources. This analysis supports implementing the principle of least privilege by ensuring that your specified resources can only be accessed by the intended principals within your organization.

Unused access analyzers help you identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.

Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs.

This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see Using Identity and Access Management Access Analyzer in the IAM User Guide.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { AccessAnalyzerClient, ListAnalyzersCommand } = require("@aws-sdk/client-accessanalyzer");
`

`ts
// ES6+ example
import { AccessAnalyzerClient, ListAnalyzersCommand } from "@aws-sdk/client-accessanalyzer";
`

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

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

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

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

// callbacks.
client.listAnalyzers(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-accessanalyzer` 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)

ApplyArchiveRule

Command API Reference / Input / Output

CancelPolicyGeneration

Command API Reference / Input / Output

CheckAccessNotGranted

Command API Reference / Input / Output

CheckNoNewAccess

Command API Reference / Input / Output

CheckNoPublicAccess

Command API Reference / Input / Output

CreateAccessPreview

Command API Reference / Input / Output

CreateAnalyzer

Command API Reference / Input / Output

CreateArchiveRule

Command API Reference / Input / Output

DeleteAnalyzer

Command API Reference / Input / Output

DeleteArchiveRule

Command API Reference / Input / Output

GenerateFindingRecommendation

Command API Reference / Input / Output

GetAccessPreview

Command API Reference / Input / Output

GetAnalyzedResource

Command API Reference / Input / Output

GetAnalyzer

Command API Reference / Input / Output

GetArchiveRule

Command API Reference / Input / Output

GetFinding

Command API Reference / Input / Output

GetFindingRecommendation

Command API Reference / Input / Output

GetFindingsStatistics

Command API Reference / Input / Output

GetFindingV2

Command API Reference / Input / Output

GetGeneratedPolicy

Command API Reference / Input / Output

ListAccessPreviewFindings

Command API Reference / Input / Output

ListAccessPreviews

Command API Reference / Input / Output

ListAnalyzedResources

Command API Reference / Input / Output

ListAnalyzers

Command API Reference / Input / Output

ListArchiveRules

Command API Reference / Input / Output

ListFindings

Command API Reference / Input / Output

ListFindingsV2

Command API Reference / Input / Output

ListPolicyGenerations

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

StartPolicyGeneration

Command API Reference / Input / Output

StartResourceScan

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAnalyzer

Command API Reference / Input / Output

UpdateArchiveRule

Command API Reference / Input / Output

UpdateFindings

Command API Reference / Input / Output

ValidatePolicy

Command API Reference / Input / Output