Skip to content

Commit

Permalink
docs(client-fsx): Doc-only update to address Lustre S3 hard-coded names.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Sep 25, 2024
1 parent 7fad224 commit becefa3
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 14 deletions.
23 changes: 14 additions & 9 deletions clients/client-fsx/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3597,8 +3597,9 @@ export interface CreateDataRepositoryAssociationRequest {
/**
* <p>The path to the Amazon S3 data repository that will be linked to the file
* system. The path can be an S3 bucket or prefix in the format
* <code>s3://myBucket/myPrefix/</code>. This path specifies where in the S3
* data repository files will be imported from or exported to.</p>
* <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>
* is optional). This path specifies where in the S3 data repository
* files will be imported from or exported to.</p>
* @public
*/
DataRepositoryPath: string | undefined;
Expand Down Expand Up @@ -3837,11 +3838,13 @@ export interface DataRepositoryAssociation {
* </li>
* <li>
* <p>For Amazon File Cache, the path can be an S3 bucket or prefix
* in the format <code>s3://myBucket/myPrefix/</code>.</p>
* in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>
* is optional).</p>
* </li>
* <li>
* <p>For Amazon FSx for Lustre, the path can be an S3 bucket or prefix
* in the format <code>s3://myBucket/myPrefix/</code>.</p>
* in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>
* is optional).</p>
* </li>
* </ul>
* @public
Expand Down Expand Up @@ -4078,9 +4081,11 @@ export interface CompletionReport {
Enabled: boolean | undefined;

/**
* <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.
* <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.
* The <code>Path</code> you provide must be located within the file system’s ExportPath.
* An example <code>Path</code> value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report:
* An example <code>Path</code> value is "s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix".
* The report provides the following information for each file in the report:
* FilePath, FileStatus, and ErrorCode.</p>
* @public
*/
Expand Down Expand Up @@ -4171,8 +4176,7 @@ export interface CreateDataRepositoryTaskRequest {
* <p>For import tasks, the list contains paths in the Amazon S3 bucket
* from which POSIX metadata changes are imported to the FSx for Lustre 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>
* <code>s3://bucket-name/prefix</code> (where <code>prefix</code> is optional).</p>
* </li>
* <li>
* <p>For release tasks, the list contains directory or file paths on the
Expand Down Expand Up @@ -4596,7 +4600,8 @@ export interface FileCacheDataRepositoryAssociation {
* </li>
* <li>
* <p>The path can be an S3 bucket or prefix
* in the format <code>s3://myBucket/myPrefix/</code>.</p>
* in the format <code>s3://bucket-name/prefix/</code> (where <code>prefix</code>
* is optional).</p>
* </li>
* </ul>
* @public
Expand Down
10 changes: 5 additions & 5 deletions codegen/sdk-codegen/aws-models/fsx.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2218,7 +2218,7 @@
"Path": {
"target": "com.amazonaws.fsx#ArchivePath",
"traits": {
"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>"
"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>"
}
},
"Format": {
Expand Down Expand Up @@ -2644,7 +2644,7 @@
"target": "com.amazonaws.fsx#ArchivePath",
"traits": {
"smithy.api#clientOptional": {},
"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>",
"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>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -2744,7 +2744,7 @@
"Paths": {
"target": "com.amazonaws.fsx#DataRepositoryTaskPaths",
"traits": {
"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>"
"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>"
}
},
"FileSystemId": {
Expand Down Expand Up @@ -4282,7 +4282,7 @@
"DataRepositoryPath": {
"target": "com.amazonaws.fsx#ArchivePath",
"traits": {
"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>"
"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>"
}
},
"BatchImportMetaDataOnCreate": {
Expand Down Expand Up @@ -6817,7 +6817,7 @@
"target": "com.amazonaws.fsx#ArchivePath",
"traits": {
"smithy.api#clientOptional": {},
"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>",
"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>",
"smithy.api#required": {}
}
},
Expand Down

0 comments on commit becefa3

Please sign in to comment.