@aws-sdk/client-s3-control

Description

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

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { S3ControlClient, ListJobsCommand } = require("@aws-sdk/client-s3-control");
`

`ts
// ES6+ example
import { S3ControlClient, ListJobsCommand } from "@aws-sdk/client-s3-control";
`

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

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

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

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

// callbacks.
client.listJobs(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-s3-control` 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)

AssociateAccessGrantsIdentityCenter

Command API Reference / Input / Output

CreateAccessGrant

Command API Reference / Input / Output

CreateAccessGrantsInstance

Command API Reference / Input / Output

CreateAccessGrantsLocation

Command API Reference / Input / Output

CreateAccessPoint

Command API Reference / Input / Output

CreateAccessPointForObjectLambda

Command API Reference / Input / Output

CreateBucket

Command API Reference / Input / Output

CreateJob

Command API Reference / Input / Output

CreateMultiRegionAccessPoint

Command API Reference / Input / Output

CreateStorageLensGroup

Command API Reference / Input / Output

DeleteAccessGrant

Command API Reference / Input / Output

DeleteAccessGrantsInstance

Command API Reference / Input / Output

DeleteAccessGrantsInstanceResourcePolicy

Command API Reference / Input / Output

DeleteAccessGrantsLocation

Command API Reference / Input / Output

DeleteAccessPoint

Command API Reference / Input / Output

DeleteAccessPointForObjectLambda

Command API Reference / Input / Output

DeleteAccessPointPolicy

Command API Reference / Input / Output

DeleteAccessPointPolicyForObjectLambda

Command API Reference / Input / Output

DeleteAccessPointScope

Command API Reference / Input / Output

DeleteBucket

Command API Reference / Input / Output

DeleteBucketLifecycleConfiguration

Command API Reference / Input / Output

DeleteBucketPolicy

Command API Reference / Input / Output

DeleteBucketReplication

Command API Reference / Input / Output

DeleteBucketTagging

Command API Reference / Input / Output

DeleteJobTagging

Command API Reference / Input / Output

DeleteMultiRegionAccessPoint

Command API Reference / Input / Output

DeletePublicAccessBlock

Command API Reference / Input / Output

DeleteStorageLensConfiguration

Command API Reference / Input / Output

DeleteStorageLensConfigurationTagging

Command API Reference / Input / Output

DeleteStorageLensGroup

Command API Reference / Input / Output

DescribeJob

Command API Reference / Input / Output

DescribeMultiRegionAccessPointOperation

Command API Reference / Input / Output

DissociateAccessGrantsIdentityCenter

Command API Reference / Input / Output

GetAccessGrant

Command API Reference / Input / Output

GetAccessGrantsInstance

Command API Reference / Input / Output

GetAccessGrantsInstanceForPrefix

Command API Reference / Input / Output

GetAccessGrantsInstanceResourcePolicy

Command API Reference / Input / Output

GetAccessGrantsLocation

Command API Reference / Input / Output

GetAccessPoint

Command API Reference / Input / Output

GetAccessPointConfigurationForObjectLambda

Command API Reference / Input / Output

GetAccessPointForObjectLambda

Command API Reference / Input / Output

GetAccessPointPolicy

Command API Reference / Input / Output

GetAccessPointPolicyForObjectLambda

Command API Reference / Input / Output

GetAccessPointPolicyStatus

Command API Reference / Input / Output

GetAccessPointPolicyStatusForObjectLambda

Command API Reference / Input / Output

GetAccessPointScope

Command API Reference / Input / Output

GetBucket

Command API Reference / Input / Output

GetBucketLifecycleConfiguration

Command API Reference / Input / Output

GetBucketPolicy

Command API Reference / Input / Output

GetBucketReplication

Command API Reference / Input / Output

GetBucketTagging

Command API Reference / Input / Output

GetBucketVersioning

Command API Reference / Input / Output

GetDataAccess

Command API Reference / Input / Output

GetJobTagging

Command API Reference / Input / Output

GetMultiRegionAccessPoint

Command API Reference / Input / Output

GetMultiRegionAccessPointPolicy

Command API Reference / Input / Output

GetMultiRegionAccessPointPolicyStatus

Command API Reference / Input / Output

GetMultiRegionAccessPointRoutes

Command API Reference / Input / Output

GetPublicAccessBlock

Command API Reference / Input / Output

GetStorageLensConfiguration

Command API Reference / Input / Output

GetStorageLensConfigurationTagging

Command API Reference / Input / Output

GetStorageLensGroup

Command API Reference / Input / Output

ListAccessGrants

Command API Reference / Input / Output

ListAccessGrantsInstances

Command API Reference / Input / Output

ListAccessGrantsLocations

Command API Reference / Input / Output

ListAccessPoints

Command API Reference / Input / Output

ListAccessPointsForDirectoryBuckets

Command API Reference / Input / Output

ListAccessPointsForObjectLambda

Command API Reference / Input / Output

ListCallerAccessGrants

Command API Reference / Input / Output

ListJobs

Command API Reference / Input / Output

ListMultiRegionAccessPoints

Command API Reference / Input / Output

ListRegionalBuckets

Command API Reference / Input / Output

ListStorageLensConfigurations

Command API Reference / Input / Output

ListStorageLensGroups

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutAccessGrantsInstanceResourcePolicy

Command API Reference / Input / Output

PutAccessPointConfigurationForObjectLambda

Command API Reference / Input / Output

PutAccessPointPolicy

Command API Reference / Input / Output

PutAccessPointPolicyForObjectLambda

Command API Reference / Input / Output

PutAccessPointScope

Command API Reference / Input / Output

PutBucketLifecycleConfiguration

Command API Reference / Input / Output

PutBucketPolicy

Command API Reference / Input / Output

PutBucketReplication

Command API Reference / Input / Output

PutBucketTagging

Command API Reference / Input / Output

PutBucketVersioning

Command API Reference / Input / Output

PutJobTagging

Command API Reference / Input / Output

PutMultiRegionAccessPointPolicy

Command API Reference / Input / Output

PutPublicAccessBlock

Command API Reference / Input / Output

PutStorageLensConfiguration

Command API Reference / Input / Output

PutStorageLensConfigurationTagging

Command API Reference / Input / Output

SubmitMultiRegionAccessPointRoutes

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAccessGrantsLocation

Command API Reference / Input / Output

UpdateJobPriority

Command API Reference / Input / Output

UpdateJobStatus

Command API Reference / Input / Output

UpdateStorageLensGroup

Command API Reference / Input / Output