Skip to content

Commit

Permalink
docs(client-fsx): Documentation updates for Amazon FSx
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jul 29, 2022
1 parent b2c026f commit 31f2a30
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 15 deletions.
3 changes: 1 addition & 2 deletions clients/client-fsx/src/FSx.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1438,8 +1438,7 @@ export class FSx extends FSxClient {
}

/**
* <p>Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for
* Windows File Server.</p>
* <p>Lists tags for Amazon FSx resources.</p>
*
* <p>When retrieving all tags, you can optionally specify the <code>MaxResults</code>
* parameter to limit the number of tags in a response. If more tags remain, Amazon FSx
Expand Down
3 changes: 1 addition & 2 deletions clients/client-fsx/src/commands/ListTagsForResourceCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {}

/**
* <p>Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for
* Windows File Server.</p>
* <p>Lists tags for Amazon FSx resources.</p>
*
* <p>When retrieving all tags, you can optionally specify the <code>MaxResults</code>
* parameter to limit the number of tags in a response. If more tags remain, Amazon FSx
Expand Down
29 changes: 21 additions & 8 deletions clients/client-fsx/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2607,11 +2607,24 @@ export interface CreateDataRepositoryTaskRequest {
Type: DataRepositoryTaskType | string | undefined;

/**
* <p>(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed.
* 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.
* If the mount point is <code>/mnt/fsx</code> and <code>/mnt/fsx/path1</code> is a directory or
* file on the file system you want to export, then the path to provide is <code>path1</code>.
* <p>A list of paths for the data repository task to use when the task is processed.
* If a path that you provide isn't valid, the task fails.</p>
* <ul>
* <li>
* <p>For export tasks, the list contains paths on the Amazon FSx file system
* from which the files are exported to the Amazon S3 bucket. 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. If the mount point is <code>/mnt/fsx</code> and
* <code>/mnt/fsx/path1</code> is a directory or file on the file system you want
* to export, then the path to provide is <code>path1</code>.</p>
* </li>
* <li>
* <p>For import tasks, the list contains paths in the Amazon S3 bucket
* from which POSIX metadata changes are imported to the Amazon FSx file system.
* The path can be an S3 bucket or prefix in the format
* <code>s3://myBucket/myPrefix</code> (where <code>myPrefix</code> is optional).</p>
* </li>
* </ul>
*/
Paths?: string[];

Expand Down Expand Up @@ -3360,12 +3373,12 @@ export interface CreateFileSystemOpenZFSConfiguration {
CopyTagsToBackups?: boolean;

/**
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots.
* <p>A Boolean value indicating whether tags for the file system should be copied to volumes.
* This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags
* for the volume are copied to snapshots where the user doesn't specify tags. If this
* for the file system are copied to volumes where the user doesn't specify tags. If this
* value is <code>true</code>, and you specify one or more tags, only the specified tags
* are copied to snapshots. If you specify one or more tags when creating the snapshot, no
* tags are copied from the volume, regardless of this value. </p>
* are copied to volumes. If you specify one or more tags when creating the volume, no
* tags are copied from the file system, regardless of this value.</p>
*/
CopyTagsToVolumes?: boolean;

Expand Down
6 changes: 3 additions & 3 deletions codegen/sdk-codegen/aws-models/fsx.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1308,7 +1308,7 @@
"Paths": {
"target": "com.amazonaws.fsx#DataRepositoryTaskPaths",
"traits": {
"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>"
"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>"
}
},
"FileSystemId": {
Expand Down Expand Up @@ -1677,7 +1677,7 @@
"CopyTagsToVolumes": {
"target": "com.amazonaws.fsx#Flag",
"traits": {
"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>"
"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>"
}
},
"DailyAutomaticBackupStartTime": {
Expand Down Expand Up @@ -5113,7 +5113,7 @@
}
],
"traits": {
"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>",
"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>",
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
Expand Down

0 comments on commit 31f2a30

Please sign in to comment.