@aws-sdk/client-efs

Description

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

Amazon Elastic File System

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With
Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you
add and remove files, so that your applications have the storage they need, when they need it.
For more information, see the Amazon Elastic File System API Reference and
the Amazon Elastic File System
User Guide.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { EFSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-efs");
`

`ts
// ES6+ example
import { EFSClient, ListTagsForResourceCommand } from "@aws-sdk/client-efs";
`

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

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

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

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

// callbacks.
client.listTagsForResource(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-efs` 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)

CreateAccessPoint

Command API Reference / Input / Output

CreateFileSystem

Command API Reference / Input / Output

CreateMountTarget

Command API Reference / Input / Output

CreateReplicationConfiguration

Command API Reference / Input / Output

CreateTags

Command API Reference / Input / Output

DeleteAccessPoint

Command API Reference / Input / Output

DeleteFileSystem

Command API Reference / Input / Output

DeleteFileSystemPolicy

Command API Reference / Input / Output

DeleteMountTarget

Command API Reference / Input / Output

DeleteReplicationConfiguration

Command API Reference / Input / Output

DeleteTags

Command API Reference / Input / Output

DescribeAccessPoints

Command API Reference / Input / Output

DescribeAccountPreferences

Command API Reference / Input / Output

DescribeBackupPolicy

Command API Reference / Input / Output

DescribeFileSystemPolicy

Command API Reference / Input / Output

DescribeFileSystems

Command API Reference / Input / Output

DescribeLifecycleConfiguration

Command API Reference / Input / Output

DescribeMountTargets

Command API Reference / Input / Output

DescribeMountTargetSecurityGroups

Command API Reference / Input / Output

DescribeReplicationConfigurations

Command API Reference / Input / Output

DescribeTags

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ModifyMountTargetSecurityGroups

Command API Reference / Input / Output

PutAccountPreferences

Command API Reference / Input / Output

PutBackupPolicy

Command API Reference / Input / Output

PutFileSystemPolicy

Command API Reference / Input / Output

PutLifecycleConfiguration

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateFileSystem

Command API Reference / Input / Output

UpdateFileSystemProtection

Command API Reference / Input / Output