Skip to content

Commit becefa3

Browse files
author
awstools
committed
docs(client-fsx): Doc-only update to address Lustre S3 hard-coded names.
1 parent 7fad224 commit becefa3

File tree

2 files changed

+19
-14
lines changed

2 files changed

+19
-14
lines changed

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

+14-9
Original file line numberDiff line numberDiff line change
@@ -3597,8 +3597,9 @@ export interface CreateDataRepositoryAssociationRequest {
35973597
/**
35983598
* <p>The path to the Amazon S3 data repository that will be linked to the file
35993599
* system. The path can be an S3 bucket or prefix in the format
3600-
* <code>s3://myBucket/myPrefix/</code>. This path specifies where in the S3
3601-
* data repository files will be imported from or exported to.</p>
3600+
* <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>
3601+
* is optional). This path specifies where in the S3 data repository
3602+
* files will be imported from or exported to.</p>
36023603
* @public
36033604
*/
36043605
DataRepositoryPath: string | undefined;
@@ -3837,11 +3838,13 @@ export interface DataRepositoryAssociation {
38373838
* </li>
38383839
* <li>
38393840
* <p>For Amazon File Cache, the path can be an S3 bucket or prefix
3840-
* in the format <code>s3://myBucket/myPrefix/</code>.</p>
3841+
* in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>
3842+
* is optional).</p>
38413843
* </li>
38423844
* <li>
38433845
* <p>For Amazon FSx for Lustre, the path can be an S3 bucket or prefix
3844-
* in the format <code>s3://myBucket/myPrefix/</code>.</p>
3846+
* in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>
3847+
* is optional).</p>
38453848
* </li>
38463849
* </ul>
38473850
* @public
@@ -4078,9 +4081,11 @@ export interface CompletionReport {
40784081
Enabled: boolean | undefined;
40794082

40804083
/**
4081-
* <p>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location.
4084+
* <p>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the location of the report on the file system's
4085+
* linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location.
40824086
* The <code>Path</code> you provide must be located within the file system’s ExportPath.
4083-
* An example <code>Path</code> value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report:
4087+
* An example <code>Path</code> value is "s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix".
4088+
* The report provides the following information for each file in the report:
40844089
* FilePath, FileStatus, and ErrorCode.</p>
40854090
* @public
40864091
*/
@@ -4171,8 +4176,7 @@ export interface CreateDataRepositoryTaskRequest {
41714176
* <p>For import tasks, the list contains paths in the Amazon S3 bucket
41724177
* from which POSIX metadata changes are imported to the FSx for Lustre file system.
41734178
* The path can be an S3 bucket or prefix in the format
4174-
* <code>s3://myBucket/myPrefix</code> (where <code>myPrefix</code> is optional).
4175-
* </p>
4179+
* <code>s3://bucket-name/prefix</code> (where <code>prefix</code> is optional).</p>
41764180
* </li>
41774181
* <li>
41784182
* <p>For release tasks, the list contains directory or file paths on the
@@ -4596,7 +4600,8 @@ export interface FileCacheDataRepositoryAssociation {
45964600
* </li>
45974601
* <li>
45984602
* <p>The path can be an S3 bucket or prefix
4599-
* in the format <code>s3://myBucket/myPrefix/</code>.</p>
4603+
* in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>
4604+
* is optional).</p>
46004605
* </li>
46014606
* </ul>
46024607
* @public

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -2218,7 +2218,7 @@
22182218
"Path": {
22192219
"target": "com.amazonaws.fsx#ArchivePath",
22202220
"traits": {
2221-
"smithy.api#documentation": "<p>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. \n The <code>Path</code> you provide must be located within the file system’s ExportPath. \n An example <code>Path</code> value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report:\n FilePath, FileStatus, and ErrorCode.</p>"
2221+
"smithy.api#documentation": "<p>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the location of the report on the file system's\n linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. \n The <code>Path</code> you provide must be located within the file system’s ExportPath. \n An example <code>Path</code> value is \"s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix\".\n The report provides the following information for each file in the report:\n FilePath, FileStatus, and ErrorCode.</p>"
22222222
}
22232223
},
22242224
"Format": {
@@ -2644,7 +2644,7 @@
26442644
"target": "com.amazonaws.fsx#ArchivePath",
26452645
"traits": {
26462646
"smithy.api#clientOptional": {},
2647-
"smithy.api#documentation": "<p>The path to the Amazon S3 data repository that will be linked to the file\n system. The path can be an S3 bucket or prefix in the format\n <code>s3://myBucket/myPrefix/</code>. This path specifies where in the S3\n data repository files will be imported from or exported to.</p>",
2647+
"smithy.api#documentation": "<p>The path to the Amazon S3 data repository that will be linked to the file\n system. The path can be an S3 bucket or prefix in the format\n <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>\n is optional). This path specifies where in the S3 data repository\n files will be imported from or exported to.</p>",
26482648
"smithy.api#required": {}
26492649
}
26502650
},
@@ -2744,7 +2744,7 @@
27442744
"Paths": {
27452745
"target": "com.amazonaws.fsx#DataRepositoryTaskPaths",
27462746
"traits": {
2747-
"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. If you don't provide\n paths, the default behavior is to export all files to S3 (for export tasks), import\n all files from S3 (for import tasks), or release all exported files that meet the\n last accessed time criteria (for release tasks).</p>\n <ul>\n <li>\n <p>For export tasks, the list contains paths on the FSx for Lustre 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 FSx for Lustre 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).\n </p>\n </li>\n <li>\n <p>For release tasks, the list contains directory or file paths on the\n FSx for Lustre file system from which to release exported files. If a directory is\n specified, files within the directory are released. If a file path is specified,\n only that file is released. To release all exported files in the file system,\n specify a forward slash (/) as the path.</p>\n <note>\n <p>A file must also meet the last accessed time criteria\n specified in for the\n file to be released.</p>\n </note>\n </li>\n </ul>"
2747+
"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. If you don't provide\n paths, the default behavior is to export all files to S3 (for export tasks), import\n all files from S3 (for import tasks), or release all exported files that meet the\n last accessed time criteria (for release tasks).</p>\n <ul>\n <li>\n <p>For export tasks, the list contains paths on the FSx for Lustre 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 FSx for Lustre file system.\n The path can be an S3 bucket or prefix in the format\n <code>s3://bucket-name/prefix</code> (where <code>prefix</code> is optional).</p>\n </li>\n <li>\n <p>For release tasks, the list contains directory or file paths on the\n FSx for Lustre file system from which to release exported files. If a directory is\n specified, files within the directory are released. If a file path is specified,\n only that file is released. To release all exported files in the file system,\n specify a forward slash (/) as the path.</p>\n <note>\n <p>A file must also meet the last accessed time criteria\n specified in for the\n file to be released.</p>\n </note>\n </li>\n </ul>"
27482748
}
27492749
},
27502750
"FileSystemId": {
@@ -4282,7 +4282,7 @@
42824282
"DataRepositoryPath": {
42834283
"target": "com.amazonaws.fsx#ArchivePath",
42844284
"traits": {
4285-
"smithy.api#documentation": "<p>The path to the data repository that will be linked to the cache\n or file system.</p>\n <ul>\n <li>\n <p>For Amazon File Cache, the path can be an NFS data repository\n that will be linked to the cache. The path can be in one of two formats:</p>\n <ul>\n <li>\n <p>If you are not using the <code>DataRepositorySubdirectories</code>\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format <code>nsf://nfs-domain-name/exportpath</code>. You can therefore\n link a single NFS Export to a single data repository association.</p>\n </li>\n <li>\n <p>If you are using the <code>DataRepositorySubdirectories</code>\n parameter, the path is the domain name of the NFS file system in the format\n <code>nfs://filer-domain-name</code>, which indicates the root of the\n subdirectories specified with the <code>DataRepositorySubdirectories</code>\n parameter.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>For Amazon File Cache, the path can be an S3 bucket or prefix\n in the format <code>s3://myBucket/myPrefix/</code>.</p>\n </li>\n <li>\n <p>For Amazon FSx for Lustre, the path can be an S3 bucket or prefix\n in the format <code>s3://myBucket/myPrefix/</code>.</p>\n </li>\n </ul>"
4285+
"smithy.api#documentation": "<p>The path to the data repository that will be linked to the cache\n or file system.</p>\n <ul>\n <li>\n <p>For Amazon File Cache, the path can be an NFS data repository\n that will be linked to the cache. The path can be in one of two formats:</p>\n <ul>\n <li>\n <p>If you are not using the <code>DataRepositorySubdirectories</code>\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format <code>nsf://nfs-domain-name/exportpath</code>. You can therefore\n link a single NFS Export to a single data repository association.</p>\n </li>\n <li>\n <p>If you are using the <code>DataRepositorySubdirectories</code>\n parameter, the path is the domain name of the NFS file system in the format\n <code>nfs://filer-domain-name</code>, which indicates the root of the\n subdirectories specified with the <code>DataRepositorySubdirectories</code>\n parameter.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>For Amazon File Cache, the path can be an S3 bucket or prefix\n in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>\n is optional).</p>\n </li>\n <li>\n <p>For Amazon FSx for Lustre, the path can be an S3 bucket or prefix\n in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>\n is optional).</p>\n </li>\n </ul>"
42864286
}
42874287
},
42884288
"BatchImportMetaDataOnCreate": {
@@ -6817,7 +6817,7 @@
68176817
"target": "com.amazonaws.fsx#ArchivePath",
68186818
"traits": {
68196819
"smithy.api#clientOptional": {},
6820-
"smithy.api#documentation": "<p>The path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:</p>\n <ul>\n <li>\n <p>The path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:</p>\n <ul>\n <li>\n <p>If you are not using the <code>DataRepositorySubdirectories</code>\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format <code>nfs://nfs-domain-name/exportpath</code>. You can therefore\n link a single NFS Export to a single data repository association.</p>\n </li>\n <li>\n <p>If you are using the <code>DataRepositorySubdirectories</code>\n parameter, the path is the domain name of the NFS file system in the format\n <code>nfs://filer-domain-name</code>, which indicates the root of the\n subdirectories specified with the <code>DataRepositorySubdirectories</code>\n parameter.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>The path can be an S3 bucket or prefix\n in the format <code>s3://myBucket/myPrefix/</code>.</p>\n </li>\n </ul>",
6820+
"smithy.api#documentation": "<p>The path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:</p>\n <ul>\n <li>\n <p>The path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:</p>\n <ul>\n <li>\n <p>If you are not using the <code>DataRepositorySubdirectories</code>\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format <code>nfs://nfs-domain-name/exportpath</code>. You can therefore\n link a single NFS Export to a single data repository association.</p>\n </li>\n <li>\n <p>If you are using the <code>DataRepositorySubdirectories</code>\n parameter, the path is the domain name of the NFS file system in the format\n <code>nfs://filer-domain-name</code>, which indicates the root of the\n subdirectories specified with the <code>DataRepositorySubdirectories</code>\n parameter.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>The path can be an S3 bucket or prefix\n in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>\n is optional).</p>\n </li>\n </ul>",
68216821
"smithy.api#required": {}
68226822
}
68236823
},

0 commit comments

Comments
 (0)