From 13d4dc2f920b47bc30999591c70355d0745a7c0f Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 15 Jun 2023 18:16:45 +0000 Subject: [PATCH] docs(client-efs): Documentation updates for EFS. --- .../src/commands/CreateAccessPointCommand.ts | 8 ++++++- .../src/commands/CreateFileSystemCommand.ts | 7 +++++- clients/client-efs/src/models/models_0.ts | 22 +++++++++++++++---- codegen/sdk-codegen/aws-models/efs.json | 6 ++--- 4 files changed, 34 insertions(+), 9 deletions(-) diff --git a/clients/client-efs/src/commands/CreateAccessPointCommand.ts b/clients/client-efs/src/commands/CreateAccessPointCommand.ts index 793ad438bb33..cc96961549e0 100644 --- a/clients/client-efs/src/commands/CreateAccessPointCommand.ts +++ b/clients/client-efs/src/commands/CreateAccessPointCommand.ts @@ -45,11 +45,17 @@ export interface CreateAccessPointCommandOutput extends AccessPointDescription, * points.

* *

If multiple requests to create access points on the same file system are sent in quick - * succession, and the file system is near the limit of 1000 access points, you may experience + * succession, and the file system is near the limit of 1,000 access points, you may experience * a throttling response for these requests. This is to ensure that the file system does not * exceed the stated access point limit.

* *

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

+ *

Access points can be tagged on creation. If tags are specified in the creation action, IAM + * performs additional authorization on the elasticfilesystem:TagResource action to + * verify if users have permissions to create tags. Therefore, you must grant explicit + * permissions to use the elasticfilesystem:TagResource action. For more + * information, see Granting + * permissions to tag resources during creation.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-efs/src/commands/CreateFileSystemCommand.ts b/clients/client-efs/src/commands/CreateFileSystemCommand.ts index 01e6b1924a50..86140dd80c06 100644 --- a/clients/client-efs/src/commands/CreateFileSystemCommand.ts +++ b/clients/client-efs/src/commands/CreateFileSystemCommand.ts @@ -83,8 +83,13 @@ export interface CreateFileSystemCommandOutput extends FileSystemDescription, __ * available, at which point you can create one or more mount targets for the file * system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in * your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

- *

This operation requires permissions for the + *

This operation requires permissions for the * elasticfilesystem:CreateFileSystem action.

+ *

File systems can be tagged on creation. If tags are specified in the creation action, IAM + * performs additional authorization on the elasticfilesystem:TagResource action to + * verify if users have permissions to create tags. Therefore, you must grant explicit + * permissions to use the elasticfilesystem:TagResource action. For more + * information, see Granting permissions to tag resources during creation.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-efs/src/models/models_0.ts b/clients/client-efs/src/models/models_0.ts index 34940d3a643c..9619639d95a5 100644 --- a/clients/client-efs/src/models/models_0.ts +++ b/clients/client-efs/src/models/models_0.ts @@ -1547,10 +1547,24 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat */ export interface Destination { /** - *

Describes the status of the destination Amazon EFS file system. If the status is - * ERROR, the destination file system in the replication configuration is in a - * failed state and is unrecoverable. To access the file system data, restore a backup of the - * failed file system to a new file system.

+ *

Describes the status of the destination Amazon EFS file system.

+ * */ Status: ReplicationStatus | string | undefined; diff --git a/codegen/sdk-codegen/aws-models/efs.json b/codegen/sdk-codegen/aws-models/efs.json index 0a240b92aed7..bb99402c5a01 100644 --- a/codegen/sdk-codegen/aws-models/efs.json +++ b/codegen/sdk-codegen/aws-models/efs.json @@ -321,7 +321,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data in\n the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access\n points.

\n \n

If multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of 1000 access points, you may experience\n a throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.

\n \n

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

", + "smithy.api#documentation": "

Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data in\n the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access\n points.

\n \n

If multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of 1,000 access points, you may experience\n a throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.

\n \n

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

\n

Access points can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource action. For more\n information, see Granting\n permissions to tag resources during creation.

", "smithy.api#http": { "method": "POST", "uri": "/2015-02-01/access-points", @@ -402,7 +402,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:

\n \n

Otherwise, this operation returns a FileSystemAlreadyExists error with the\n ID of the existing file system.

\n \n

For basic use cases, you can use a randomly generated UUID for the creation\n token.

\n \n

The idempotent operation allows you to retry a CreateFileSystem call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists error.

\n

For more information, see \n Creating a file system\n in the Amazon EFS User Guide.

\n \n

The CreateFileSystem call returns while the file system's lifecycle\n state is still creating. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.

\n \n

This operation accepts an optional PerformanceMode parameter that you\n choose for your file system. We recommend generalPurpose performance mode for\n most file systems. File systems using the maxIO performance mode can scale to\n higher levels of aggregate throughput and operations per second with a tradeoff of slightly\n higher latencies for most file operations. The performance mode can't be changed after\n the file system has been created. For more information, see Amazon EFS performance\n modes.

\n

You can set the throughput mode for the file system using the ThroughputMode parameter.

\n

After the file system is fully created, Amazon EFS sets its lifecycle state to\n available, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

\n

This operation requires permissions for the\n elasticfilesystem:CreateFileSystem action.

", + "smithy.api#documentation": "

Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:

\n \n

Otherwise, this operation returns a FileSystemAlreadyExists error with the\n ID of the existing file system.

\n \n

For basic use cases, you can use a randomly generated UUID for the creation\n token.

\n \n

The idempotent operation allows you to retry a CreateFileSystem call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists error.

\n

For more information, see \n Creating a file system\n in the Amazon EFS User Guide.

\n \n

The CreateFileSystem call returns while the file system's lifecycle\n state is still creating. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.

\n \n

This operation accepts an optional PerformanceMode parameter that you\n choose for your file system. We recommend generalPurpose performance mode for\n most file systems. File systems using the maxIO performance mode can scale to\n higher levels of aggregate throughput and operations per second with a tradeoff of slightly\n higher latencies for most file operations. The performance mode can't be changed after\n the file system has been created. For more information, see Amazon EFS performance\n modes.

\n

You can set the throughput mode for the file system using the ThroughputMode parameter.

\n

After the file system is fully created, Amazon EFS sets its lifecycle state to\n available, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

\n

This operation requires permissions for the\n elasticfilesystem:CreateFileSystem action.

\n

File systems can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource action. For more\n information, see Granting permissions to tag resources during creation.

", "smithy.api#http": { "method": "POST", "uri": "/2015-02-01/file-systems", @@ -1784,7 +1784,7 @@ "Status": { "target": "com.amazonaws.efs#ReplicationStatus", "traits": { - "smithy.api#documentation": "

Describes the status of the destination Amazon EFS file system. If the status is\n ERROR, the destination file system in the replication configuration is in a\n failed state and is unrecoverable. To access the file system data, restore a backup of the\n failed file system to a new file system.

", + "smithy.api#documentation": "

Describes the status of the destination Amazon EFS file system.

\n ", "smithy.api#required": {} } },