@aws-sdk/client-efs 3.287.0 → 3.289.0

package/dist-types/commands/CreateFileSystemCommand.d.ts

@@ -77,6 +77,47 @@ export interface CreateFileSystemCommandOutput extends FileSystemDescription, __
  * @see {@link CreateFileSystemCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To create a new file system
+ * ```javascript
+ * // This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode.
+ * const input = {
+ *   "Backup": true,
+ *   "CreationToken": "tokenstring",
+ *   "Encrypted": true,
+ *   "PerformanceMode": "generalPurpose",
+ *   "Tags": [
+ *     {
+ *       "Key": "Name",
+ *       "Value": "MyFileSystem"
+ *     }
+ *   ]
+ * };
+ * const command = new CreateFileSystemCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CreationTime": "1481841524.0",
+ *   "CreationToken": "tokenstring",
+ *   "Encrypted": true,
+ *   "FileSystemId": "fs-01234567",
+ *   "LifeCycleState": "creating",
+ *   "NumberOfMountTargets": 0,
+ *   "OwnerId": "012345678912",
+ *   "PerformanceMode": "generalPurpose",
+ *   "SizeInBytes": {
+ *     "Value": 0
+ *   },
+ *   "Tags": [
+ *     {
+ *       "Key": "Name",
+ *       "Value": "MyFileSystem"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-create-a-new-file-system-1481840798547
+ * ```
+ *
  */
 export declare class CreateFileSystemCommand extends $Command<CreateFileSystemCommandInput, CreateFileSystemCommandOutput, EFSClientResolvedConfig> {
     readonly input: CreateFileSystemCommandInput;

package/dist-types/commands/CreateMountTargetCommand.d.ts

@@ -168,6 +168,29 @@ export interface CreateMountTargetCommandOutput extends MountTargetDescription,
  * @see {@link CreateMountTargetCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To create a new mount target
+ * ```javascript
+ * // This operation creates a new mount target for an EFS file system.
+ * const input = {
+ *   "FileSystemId": "fs-01234567",
+ *   "SubnetId": "subnet-1234abcd"
+ * };
+ * const command = new CreateMountTargetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FileSystemId": "fs-01234567",
+ *   "IpAddress": "192.0.0.2",
+ *   "LifeCycleState": "creating",
+ *   "MountTargetId": "fsmt-12340abc",
+ *   "NetworkInterfaceId": "eni-cedf6789",
+ *   "OwnerId": "012345678912",
+ *   "SubnetId": "subnet-1234abcd"
+ * }
+ * *\/
+ * // example id: to-create-a-new-mount-target-1481842289329
+ * ```
+ *
  */
 export declare class CreateMountTargetCommand extends $Command<CreateMountTargetCommandInput, CreateMountTargetCommandOutput, EFSClientResolvedConfig> {
     readonly input: CreateMountTargetCommandInput;

package/dist-types/commands/CreateTagsCommand.d.ts

@@ -40,6 +40,23 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {
  * @see {@link CreateTagsCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To create a new tag
+ * ```javascript
+ * // This operation creates a new tag for an EFS file system.
+ * const input = {
+ *   "FileSystemId": "fs-01234567",
+ *   "Tags": [
+ *     {
+ *       "Key": "Name",
+ *       "Value": "MyFileSystem"
+ *     }
+ *   ]
+ * };
+ * const command = new CreateTagsCommand(input);
+ * await client.send(command);
+ * // example id: to-create-a-new-tag-1481843409357
+ * ```
+ *
  */
 export declare class CreateTagsCommand extends $Command<CreateTagsCommandInput, CreateTagsCommandOutput, EFSClientResolvedConfig> {
     readonly input: CreateTagsCommandInput;

package/dist-types/commands/DeleteFileSystemCommand.d.ts

@@ -48,6 +48,17 @@ export interface DeleteFileSystemCommandOutput extends __MetadataBearer {
  * @see {@link DeleteFileSystemCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To delete a file system
+ * ```javascript
+ * // This operation deletes an EFS file system.
+ * const input = {
+ *   "FileSystemId": "fs-01234567"
+ * };
+ * const command = new DeleteFileSystemCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-file-system-1481847318348
+ * ```
+ *
  */
 export declare class DeleteFileSystemCommand extends $Command<DeleteFileSystemCommandInput, DeleteFileSystemCommandOutput, EFSClientResolvedConfig> {
     readonly input: DeleteFileSystemCommandInput;

package/dist-types/commands/DeleteMountTargetCommand.d.ts

@@ -59,6 +59,17 @@ export interface DeleteMountTargetCommandOutput extends __MetadataBearer {
  * @see {@link DeleteMountTargetCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To delete a mount target
+ * ```javascript
+ * // This operation deletes a mount target.
+ * const input = {
+ *   "MountTargetId": "fsmt-12340abc"
+ * };
+ * const command = new DeleteMountTargetCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-mount-target-1481847635607
+ * ```
+ *
  */
 export declare class DeleteMountTargetCommand extends $Command<DeleteMountTargetCommandInput, DeleteMountTargetCommandOutput, EFSClientResolvedConfig> {
     readonly input: DeleteMountTargetCommandInput;

package/dist-types/commands/DeleteTagsCommand.d.ts

@@ -40,6 +40,20 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {
  * @see {@link DeleteTagsCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To delete tags for an EFS file system
+ * ```javascript
+ * // This operation deletes tags for an EFS file system.
+ * const input = {
+ *   "FileSystemId": "fs-01234567",
+ *   "TagKeys": [
+ *     "Name"
+ *   ]
+ * };
+ * const command = new DeleteTagsCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-tags-for-an-efs-file-system-1481848189061
+ * ```
+ *
  */
 export declare class DeleteTagsCommand extends $Command<DeleteTagsCommandInput, DeleteTagsCommandOutput, EFSClientResolvedConfig> {
     readonly input: DeleteTagsCommandInput;

package/dist-types/commands/DescribeFileSystemsCommand.d.ts

@@ -48,6 +48,40 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes
  * @see {@link DescribeFileSystemsCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To describe an EFS file system
+ * ```javascript
+ * // This operation describes all of the EFS file systems in an account.
+ * const input = {};
+ * const command = new DescribeFileSystemsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FileSystems": [
+ *     {
+ *       "CreationTime": "1481841524.0",
+ *       "CreationToken": "tokenstring",
+ *       "FileSystemId": "fs-01234567",
+ *       "LifeCycleState": "available",
+ *       "Name": "MyFileSystem",
+ *       "NumberOfMountTargets": 1,
+ *       "OwnerId": "012345678912",
+ *       "PerformanceMode": "generalPurpose",
+ *       "SizeInBytes": {
+ *         "Value": 6144
+ *       },
+ *       "Tags": [
+ *         {
+ *           "Key": "Name",
+ *           "Value": "MyFileSystem"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-an-efs-file-system-1481848448460
+ * ```
+ *
  */
 export declare class DescribeFileSystemsCommand extends $Command<DescribeFileSystemsCommandInput, DescribeFileSystemsCommandOutput, EFSClientResolvedConfig> {
     readonly input: DescribeFileSystemsCommandInput;

package/dist-types/commands/DescribeLifecycleConfigurationCommand.d.ts

@@ -37,6 +37,26 @@ export interface DescribeLifecycleConfigurationCommandOutput extends LifecycleCo
  * @see {@link DescribeLifecycleConfigurationCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To describe the lifecycle configuration for a file system
+ * ```javascript
+ * // This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class.
+ * const input = {
+ *   "FileSystemId": "fs-01234567"
+ * };
+ * const command = new DescribeLifecycleConfigurationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LifecyclePolicies": [
+ *     {
+ *       "TransitionToIA": "AFTER_30_DAYS"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-lifecycle-configuration-for-a-file-system-1551200664502
+ * ```
+ *
  */
 export declare class DescribeLifecycleConfigurationCommand extends $Command<DescribeLifecycleConfigurationCommandInput, DescribeLifecycleConfigurationCommandOutput, EFSClientResolvedConfig> {
     readonly input: DescribeLifecycleConfigurationCommandInput;

package/dist-types/commands/DescribeMountTargetSecurityGroupsCommand.d.ts

@@ -44,6 +44,24 @@ export interface DescribeMountTargetSecurityGroupsCommandOutput extends Describe
  * @see {@link DescribeMountTargetSecurityGroupsCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To describe the security groups for a mount target
+ * ```javascript
+ * // This operation describes all of the security groups for a file system's mount target.
+ * const input = {
+ *   "MountTargetId": "fsmt-12340abc"
+ * };
+ * const command = new DescribeMountTargetSecurityGroupsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SecurityGroups": [
+ *     "sg-4567abcd"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-security-groups-for-a-mount-target-1481849317823
+ * ```
+ *
  */
 export declare class DescribeMountTargetSecurityGroupsCommand extends $Command<DescribeMountTargetSecurityGroupsCommandInput, DescribeMountTargetSecurityGroupsCommandOutput, EFSClientResolvedConfig> {
     readonly input: DescribeMountTargetSecurityGroupsCommandInput;

package/dist-types/commands/DescribeMountTargetsCommand.d.ts

@@ -35,6 +35,32 @@ export interface DescribeMountTargetsCommandOutput extends DescribeMountTargetsR
  * @see {@link DescribeMountTargetsCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To describe the mount targets for a file system
+ * ```javascript
+ * // This operation describes all of a file system's mount targets.
+ * const input = {
+ *   "FileSystemId": "fs-01234567"
+ * };
+ * const command = new DescribeMountTargetsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "MountTargets": [
+ *     {
+ *       "FileSystemId": "fs-01234567",
+ *       "IpAddress": "192.0.0.2",
+ *       "LifeCycleState": "available",
+ *       "MountTargetId": "fsmt-12340abc",
+ *       "NetworkInterfaceId": "eni-cedf6789",
+ *       "OwnerId": "012345678912",
+ *       "SubnetId": "subnet-1234abcd"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-mount-targets-for-a-file-system-1481849958584
+ * ```
+ *
  */
 export declare class DescribeMountTargetsCommand extends $Command<DescribeMountTargetsCommandInput, DescribeMountTargetsCommandOutput, EFSClientResolvedConfig> {
     readonly input: DescribeMountTargetsCommandInput;

package/dist-types/commands/DescribeTagsCommand.d.ts

@@ -40,6 +40,27 @@ export interface DescribeTagsCommandOutput extends DescribeTagsResponse, __Metad
  * @see {@link DescribeTagsCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To describe the tags for a file system
+ * ```javascript
+ * // This operation describes all of a file system's tags.
+ * const input = {
+ *   "FileSystemId": "fs-01234567"
+ * };
+ * const command = new DescribeTagsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Tags": [
+ *     {
+ *       "Key": "Name",
+ *       "Value": "MyFileSystem"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-tags-for-a-file-system-1481850497090
+ * ```
+ *
  */
 export declare class DescribeTagsCommand extends $Command<DescribeTagsCommandInput, DescribeTagsCommandOutput, EFSClientResolvedConfig> {
     readonly input: DescribeTagsCommandInput;

package/dist-types/commands/ModifyMountTargetSecurityGroupsCommand.d.ts

@@ -48,6 +48,20 @@ export interface ModifyMountTargetSecurityGroupsCommandOutput extends __Metadata
  * @see {@link ModifyMountTargetSecurityGroupsCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example To modify the security groups associated with a mount target for a file system
+ * ```javascript
+ * // This operation modifies the security groups associated with a mount target for a file system.
+ * const input = {
+ *   "MountTargetId": "fsmt-12340abc",
+ *   "SecurityGroups": [
+ *     "sg-abcd1234"
+ *   ]
+ * };
+ * const command = new ModifyMountTargetSecurityGroupsCommand(input);
+ * await client.send(command);
+ * // example id: to-modify-the-security-groups-associated-with-a-mount-target-for-a-file-system-1481850772562
+ * ```
+ *
  */
 export declare class ModifyMountTargetSecurityGroupsCommand extends $Command<ModifyMountTargetSecurityGroupsCommandInput, ModifyMountTargetSecurityGroupsCommandOutput, EFSClientResolvedConfig> {
     readonly input: ModifyMountTargetSecurityGroupsCommandInput;

package/dist-types/commands/PutLifecycleConfigurationCommand.d.ts

@@ -75,6 +75,31 @@ export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigu
  * @see {@link PutLifecycleConfigurationCommandOutput} for command's `response` shape.
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
  *
+ * @example Creates a new lifecycleconfiguration object for a file system
+ * ```javascript
+ * // This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.
+ * const input = {
+ *   "FileSystemId": "fs-01234567",
+ *   "LifecyclePolicies": [
+ *     {
+ *       "TransitionToIA": "AFTER_30_DAYS"
+ *     }
+ *   ]
+ * };
+ * const command = new PutLifecycleConfigurationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LifecyclePolicies": [
+ *     {
+ *       "TransitionToIA": "AFTER_30_DAYS"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: creates-a-new-lifecycleconfiguration-object-for-a-file-system-1551201594692
+ * ```
+ *
  */
 export declare class PutLifecycleConfigurationCommand extends $Command<PutLifecycleConfigurationCommandInput, PutLifecycleConfigurationCommandOutput, EFSClientResolvedConfig> {
     readonly input: PutLifecycleConfigurationCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-efs",
   "description": "AWS SDK for JavaScript Efs Client for Node.js, Browser and React Native",
-  "version": "3.287.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.287.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.287.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.287.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
     "tslib": "^2.3.1",
     "uuid": "^8.3.2"