Skip to content

Commit

Permalink
docs(client-efs): Documentation updates for EFS.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jun 15, 2023
1 parent ecc9b5f commit 13d4dc2
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 9 deletions.
8 changes: 7 additions & 1 deletion clients/client-efs/src/commands/CreateAccessPointCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,17 @@ export interface CreateAccessPointCommandOutput extends AccessPointDescription,
* points</a>.</p>
* <note>
* <p>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.</p>
* </note>
* <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p>
* <p>Access points can be tagged on creation. If tags are specified in the creation action, IAM
* performs additional authorization on the <code>elasticfilesystem:TagResource</code> action to
* verify if users have permissions to create tags. Therefore, you must grant explicit
* permissions to use the <code>elasticfilesystem:TagResource</code> action. For more
* information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html">Granting
* permissions to tag resources during creation</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
7 changes: 6 additions & 1 deletion clients/client-efs/src/commands/CreateFileSystemCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,13 @@ export interface CreateFileSystemCommandOutput extends FileSystemDescription, __
* <code>available</code>, at which point you can create one or more mount targets for the file
* system in your VPC. For more information, see <a>CreateMountTarget</a>. You mount your Amazon EFS file system on an EC2 instances in
* your VPC by using the mount target. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a>. </p>
* <p> This operation requires permissions for the
* <p>This operation requires permissions for the
* <code>elasticfilesystem:CreateFileSystem</code> action. </p>
* <p>File systems can be tagged on creation. If tags are specified in the creation action, IAM
* performs additional authorization on the <code>elasticfilesystem:TagResource</code> action to
* verify if users have permissions to create tags. Therefore, you must grant explicit
* permissions to use the <code>elasticfilesystem:TagResource</code> action. For more
* information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html">Granting permissions to tag resources during creation</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
22 changes: 18 additions & 4 deletions clients/client-efs/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1547,10 +1547,24 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat
*/
export interface Destination {
/**
* <p>Describes the status of the destination Amazon EFS file system. If the status is
* <code>ERROR</code>, 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.</p>
* <p>Describes the status of the destination Amazon EFS file system.</p>
* <ul>
* <li>
* <p>The <code>Paused</code> state occurs as a result of opting out of the source or
* destination Region after the replication configuration was created. To resume replication
* for the file system, you need to again opt in to the Amazon Web Services Region. For more
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Managing Amazon Web Services Regions</a> in the <i>Amazon Web Services General Reference
* Guide</i>.</p>
* </li>
* <li>
* <p>The <code>Error</code> state occurs when either the source or the destination file
* system (or both) is in a failed state and is unrecoverable. For more information, see
* <a href="https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html">Monitoring
* replication status</a> in the <i>Amazon EFS User Guide</i>. You must delete the replication configuration, and then
* restore the most recent backup of the failed file system (either the source or the
* destination) to a new file system.</p>
* </li>
* </ul>
*/
Status: ReplicationStatus | string | undefined;

Expand Down
6 changes: 3 additions & 3 deletions codegen/sdk-codegen/aws-models/efs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html\">Mounting a file system using EFS access\n points</a>.</p>\n <note>\n <p>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.</p>\n </note>\n <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p>",
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html\">Mounting a file system using EFS access\n points</a>.</p>\n <note>\n <p>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.</p>\n </note>\n <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p>\n <p>Access points can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the <code>elasticfilesystem:TagResource</code> action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the <code>elasticfilesystem:TagResource</code> action. For more\n information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html\">Granting\n permissions to tag resources during creation</a>.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/2015-02-01/access-points",
Expand Down Expand Up @@ -402,7 +402,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>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:</p>\n <ul>\n <li>\n <p>Creates a new, empty file system. The file system will have an Amazon EFS assigned\n ID, and an initial lifecycle state <code>creating</code>.</p>\n </li>\n <li>\n <p>Returns with the description of the created file system.</p>\n </li>\n </ul>\n <p>Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the\n ID of the existing file system.</p>\n <note>\n <p>For basic use cases, you can use a randomly generated UUID for the creation\n token.</p>\n </note>\n <p> The idempotent operation allows you to retry a <code>CreateFileSystem</code> 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 <code>FileSystemAlreadyExists</code> error.</p>\n <p>For more information, see \n <a href=\"https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1\">Creating a file system</a>\n in the <i>Amazon EFS User Guide</i>.</p>\n <note>\n <p>The <code>CreateFileSystem</code> call returns while the file system's lifecycle\n state is still <code>creating</code>. You can check the file system creation status by\n calling the <a>DescribeFileSystems</a> operation, which among other things returns the file\n system state.</p>\n </note>\n <p>This operation accepts an optional <code>PerformanceMode</code> parameter that you\n choose for your file system. We recommend <code>generalPurpose</code> performance mode for\n most file systems. File systems using the <code>maxIO</code> 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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html\">Amazon EFS performance\n modes</a>.</p>\n <p>You can set the throughput mode for the file system using the <code>ThroughputMode</code> parameter.</p>\n <p>After the file system is fully created, Amazon EFS sets its lifecycle state to\n <code>available</code>, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see <a>CreateMountTarget</a>. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. </p>\n <p> This operation requires permissions for the\n <code>elasticfilesystem:CreateFileSystem</code> action. </p>",
"smithy.api#documentation": "<p>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:</p>\n <ul>\n <li>\n <p>Creates a new, empty file system. The file system will have an Amazon EFS assigned\n ID, and an initial lifecycle state <code>creating</code>.</p>\n </li>\n <li>\n <p>Returns with the description of the created file system.</p>\n </li>\n </ul>\n <p>Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the\n ID of the existing file system.</p>\n <note>\n <p>For basic use cases, you can use a randomly generated UUID for the creation\n token.</p>\n </note>\n <p> The idempotent operation allows you to retry a <code>CreateFileSystem</code> 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 <code>FileSystemAlreadyExists</code> error.</p>\n <p>For more information, see \n <a href=\"https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1\">Creating a file system</a>\n in the <i>Amazon EFS User Guide</i>.</p>\n <note>\n <p>The <code>CreateFileSystem</code> call returns while the file system's lifecycle\n state is still <code>creating</code>. You can check the file system creation status by\n calling the <a>DescribeFileSystems</a> operation, which among other things returns the file\n system state.</p>\n </note>\n <p>This operation accepts an optional <code>PerformanceMode</code> parameter that you\n choose for your file system. We recommend <code>generalPurpose</code> performance mode for\n most file systems. File systems using the <code>maxIO</code> 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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html\">Amazon EFS performance\n modes</a>.</p>\n <p>You can set the throughput mode for the file system using the <code>ThroughputMode</code> parameter.</p>\n <p>After the file system is fully created, Amazon EFS sets its lifecycle state to\n <code>available</code>, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see <a>CreateMountTarget</a>. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. </p>\n <p>This operation requires permissions for the\n <code>elasticfilesystem:CreateFileSystem</code> action. </p>\n <p>File systems can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the <code>elasticfilesystem:TagResource</code> action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the <code>elasticfilesystem:TagResource</code> action. For more\n information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html\">Granting permissions to tag resources during creation</a>.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/2015-02-01/file-systems",
Expand Down Expand Up @@ -1784,7 +1784,7 @@
"Status": {
"target": "com.amazonaws.efs#ReplicationStatus",
"traits": {
"smithy.api#documentation": "<p>Describes the status of the destination Amazon EFS file system. If the status is\n <code>ERROR</code>, 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.</p>",
"smithy.api#documentation": "<p>Describes the status of the destination Amazon EFS file system.</p>\n <ul>\n <li>\n <p>The <code>Paused</code> state occurs as a result of opting out of the source or\n destination Region after the replication configuration was created. To resume replication\n for the file system, you need to again opt in to the Amazon Web Services Region. For more\n information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable\">Managing Amazon Web Services Regions</a> in the <i>Amazon Web Services General Reference\n Guide</i>.</p>\n </li>\n <li>\n <p>The <code>Error</code> state occurs when either the source or the destination file\n system (or both) is in a failed state and is unrecoverable. For more information, see\n <a href=\"https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html\">Monitoring\n replication status</a> in the <i>Amazon EFS User Guide</i>. You must delete the replication configuration, and then\n restore the most recent backup of the failed file system (either the source or the\n destination) to a new file system.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
Expand Down

0 comments on commit 13d4dc2

Please sign in to comment.