Skip to content

Commit 31f2a30

Browse files
author
awstools
committed
docs(client-fsx): Documentation updates for Amazon FSx
1 parent b2c026f commit 31f2a30

File tree

4 files changed

+26
-15
lines changed

4 files changed

+26
-15
lines changed

clients/client-fsx/src/FSx.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1438,8 +1438,7 @@ export class FSx extends FSxClient {
14381438
}
14391439

14401440
/**
1441-
* <p>Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for
1442-
* Windows File Server.</p>
1441+
* <p>Lists tags for Amazon FSx resources.</p>
14431442
*
14441443
* <p>When retrieving all tags, you can optionally specify the <code>MaxResults</code>
14451444
* parameter to limit the number of tags in a response. If more tags remain, Amazon FSx

clients/client-fsx/src/commands/ListTagsForResourceCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
2828
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for
32-
* Windows File Server.</p>
31+
* <p>Lists tags for Amazon FSx resources.</p>
3332
*
3433
* <p>When retrieving all tags, you can optionally specify the <code>MaxResults</code>
3534
* parameter to limit the number of tags in a response. If more tags remain, Amazon FSx

clients/client-fsx/src/models/models_0.ts

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2607,11 +2607,24 @@ export interface CreateDataRepositoryTaskRequest {
26072607
Type: DataRepositoryTaskType | string | undefined;
26082608

26092609
/**
2610-
* <p>(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed.
2611-
* The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system.
2612-
* If the mount point is <code>/mnt/fsx</code> and <code>/mnt/fsx/path1</code> is a directory or
2613-
* file on the file system you want to export, then the path to provide is <code>path1</code>.
2610+
* <p>A list of paths for the data repository task to use when the task is processed.
26142611
* If a path that you provide isn't valid, the task fails.</p>
2612+
* <ul>
2613+
* <li>
2614+
* <p>For export tasks, the list contains paths on the Amazon FSx file system
2615+
* from which the files are exported to the Amazon S3 bucket. The default path is the
2616+
* file system root directory. The paths you provide need to be relative to the mount
2617+
* point of the file system. If the mount point is <code>/mnt/fsx</code> and
2618+
* <code>/mnt/fsx/path1</code> is a directory or file on the file system you want
2619+
* to export, then the path to provide is <code>path1</code>.</p>
2620+
* </li>
2621+
* <li>
2622+
* <p>For import tasks, the list contains paths in the Amazon S3 bucket
2623+
* from which POSIX metadata changes are imported to the Amazon FSx file system.
2624+
* The path can be an S3 bucket or prefix in the format
2625+
* <code>s3://myBucket/myPrefix</code> (where <code>myPrefix</code> is optional).</p>
2626+
* </li>
2627+
* </ul>
26152628
*/
26162629
Paths?: string[];
26172630

@@ -3360,12 +3373,12 @@ export interface CreateFileSystemOpenZFSConfiguration {
33603373
CopyTagsToBackups?: boolean;
33613374

33623375
/**
3363-
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots.
3376+
* <p>A Boolean value indicating whether tags for the file system should be copied to volumes.
33643377
* This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags
3365-
* for the volume are copied to snapshots where the user doesn't specify tags. If this
3378+
* for the file system are copied to volumes where the user doesn't specify tags. If this
33663379
* value is <code>true</code>, and you specify one or more tags, only the specified tags
3367-
* are copied to snapshots. If you specify one or more tags when creating the snapshot, no
3368-
* tags are copied from the volume, regardless of this value. </p>
3380+
* are copied to volumes. If you specify one or more tags when creating the volume, no
3381+
* tags are copied from the file system, regardless of this value.</p>
33693382
*/
33703383
CopyTagsToVolumes?: boolean;
33713384

codegen/sdk-codegen/aws-models/fsx.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1308,7 +1308,7 @@
13081308
"Paths": {
13091309
"target": "com.amazonaws.fsx#DataRepositoryTaskPaths",
13101310
"traits": {
1311-
"smithy.api#documentation": "<p>(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. \n The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. \n If the mount point is <code>/mnt/fsx</code> and <code>/mnt/fsx/path1</code> is a directory or \n file on the file system you want to export, then the path to provide is <code>path1</code>.\n If a path that you provide isn't valid, the task fails.</p>"
1311+
"smithy.api#documentation": "<p>A list of paths for the data repository task to use when the task is processed.\n If a path that you provide isn't valid, the task fails.</p>\n <ul>\n <li>\n <p>For export tasks, the list contains paths on the Amazon FSx file system\n from which the files are exported to the Amazon S3 bucket. The default path is the\n file system root directory. The paths you provide need to be relative to the mount\n point of the file system. If the mount point is <code>/mnt/fsx</code> and\n <code>/mnt/fsx/path1</code> is a directory or file on the file system you want\n to export, then the path to provide is <code>path1</code>.</p>\n </li>\n <li>\n <p>For import tasks, the list contains paths in the Amazon S3 bucket\n from which POSIX metadata changes are imported to the Amazon FSx file system.\n The path can be an S3 bucket or prefix in the format\n <code>s3://myBucket/myPrefix</code> (where <code>myPrefix</code> is optional).</p>\n </li>\n </ul>"
13121312
}
13131313
},
13141314
"FileSystemId": {
@@ -1677,7 +1677,7 @@
16771677
"CopyTagsToVolumes": {
16781678
"target": "com.amazonaws.fsx#Flag",
16791679
"traits": {
1680-
"smithy.api#documentation": "<p>A Boolean value indicating whether tags for the volume should be copied to snapshots.\n This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags\n for the volume are copied to snapshots where the user doesn't specify tags. If this\n value is <code>true</code>, and you specify one or more tags, only the specified tags\n are copied to snapshots. If you specify one or more tags when creating the snapshot, no\n tags are copied from the volume, regardless of this value. </p>"
1680+
"smithy.api#documentation": "<p>A Boolean value indicating whether tags for the file system should be copied to volumes.\n This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags\n for the file system are copied to volumes where the user doesn't specify tags. If this\n value is <code>true</code>, and you specify one or more tags, only the specified tags\n are copied to volumes. If you specify one or more tags when creating the volume, no\n tags are copied from the file system, regardless of this value.</p>"
16811681
}
16821682
},
16831683
"DailyAutomaticBackupStartTime": {
@@ -5113,7 +5113,7 @@
51135113
}
51145114
],
51155115
"traits": {
5116-
"smithy.api#documentation": "<p>Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for\n Windows File Server.</p>\n\n <p>When retrieving all tags, you can optionally specify the <code>MaxResults</code>\n parameter to limit the number of tags in a response. If more tags remain, Amazon FSx\n returns a <code>NextToken</code> value in the response. In this case, send a later\n request with the <code>NextToken</code> request parameter set to the value of\n <code>NextToken</code> from the last response.</p>\n\n <p>This action is used in an iterative process to retrieve a list of your tags.\n <code>ListTagsForResource</code> is called first without a\n <code>NextToken</code>value. Then the action continues to be called with the\n <code>NextToken</code> parameter set to the value of the last <code>NextToken</code>\n value until a response has no <code>NextToken</code>.</p>\n\n <p>When using this action, keep the following in mind:</p>\n <ul>\n <li>\n <p>The implementation might return fewer than <code>MaxResults</code> file\n system descriptions while still including a <code>NextToken</code>\n value.</p>\n\n </li>\n <li>\n <p>The order of tags returned in the response of one\n <code>ListTagsForResource</code> call and the order of tags returned across\n the responses of a multi-call iteration is unspecified.</p>\n </li>\n </ul>",
5116+
"smithy.api#documentation": "<p>Lists tags for Amazon FSx resources.</p>\n\n <p>When retrieving all tags, you can optionally specify the <code>MaxResults</code>\n parameter to limit the number of tags in a response. If more tags remain, Amazon FSx\n returns a <code>NextToken</code> value in the response. In this case, send a later\n request with the <code>NextToken</code> request parameter set to the value of\n <code>NextToken</code> from the last response.</p>\n\n <p>This action is used in an iterative process to retrieve a list of your tags.\n <code>ListTagsForResource</code> is called first without a\n <code>NextToken</code>value. Then the action continues to be called with the\n <code>NextToken</code> parameter set to the value of the last <code>NextToken</code>\n value until a response has no <code>NextToken</code>.</p>\n\n <p>When using this action, keep the following in mind:</p>\n <ul>\n <li>\n <p>The implementation might return fewer than <code>MaxResults</code> file\n system descriptions while still including a <code>NextToken</code>\n value.</p>\n\n </li>\n <li>\n <p>The order of tags returned in the response of one\n <code>ListTagsForResource</code> call and the order of tags returned across\n the responses of a multi-call iteration is unspecified.</p>\n </li>\n </ul>",
51175117
"smithy.api#paginated": {
51185118
"inputToken": "NextToken",
51195119
"outputToken": "NextToken",

0 commit comments

Comments
 (0)