From 9326b4df727833c4ef4ffde41c88fb13827a54ca Mon Sep 17 00:00:00 2001
From: awstools Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
- * PENDING
or EXECUTING
state. When you cancel a task, Amazon FSx does the following.PENDING
or EXECUTING
state. When you cancel am export task, Amazon FSx
+ * does the following.
Any files that FSx has already exported are not reverted.
*FSx continues to export any files that are "in-flight" when the cancel operation is received.
+ *FSx continues to export any files that are in-flight when the cancel operation is received.
*FSx does not export any files that have not yet been exported.
*For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that + * have already been released will remain in the released state.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-fsx/src/commands/CopyBackupCommand.ts b/clients/client-fsx/src/commands/CopyBackupCommand.ts index cfc6940c609cf..73f02d0f8cb15 100644 --- a/clients/client-fsx/src/commands/CopyBackupCommand.ts +++ b/clients/client-fsx/src/commands/CopyBackupCommand.ts @@ -157,6 +157,10 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * // FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * // AuditLogDestination: "STRING_VALUE", * // }, + * // DiskIopsConfiguration: { // DiskIopsConfiguration + * // Mode: "AUTOMATIC" || "USER_PROVISIONED", + * // Iops: Number("long"), + * // }, * // }, * // LustreConfiguration: { // LustreFileSystemConfiguration * // WeeklyMaintenanceStartTime: "STRING_VALUE", @@ -191,7 +195,7 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * // }, * // AdministrativeActions: [ // AdministrativeActions * // { // AdministrativeAction - * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE", + * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION", * // ProgressPercent: Number("int"), * // RequestTime: new Date("TIMESTAMP"), * // Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING", @@ -251,6 +255,10 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * // FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * // AuditLogDestination: "STRING_VALUE", * // }, + * // DiskIopsConfiguration: { + * // Mode: "AUTOMATIC" || "USER_PROVISIONED", + * // Iops: Number("long"), + * // }, * // }, * // LustreConfiguration: { * // WeeklyMaintenanceStartTime: "STRING_VALUE", @@ -285,7 +293,7 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * // }, * // AdministrativeActions: [ * // { - * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE", + * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION", * // ProgressPercent: Number("int"), * // RequestTime: new Date("TIMESTAMP"), * // Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING", @@ -418,7 +426,7 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * // ], * // }, * // }, - * // DiskIopsConfiguration: { // DiskIopsConfiguration + * // DiskIopsConfiguration: { * // Mode: "AUTOMATIC" || "USER_PROVISIONED", * // Iops: Number("long"), * // }, @@ -436,7 +444,7 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * // CopyTagsToBackups: true || false, * // CopyTagsToVolumes: true || false, * // DailyAutomaticBackupStartTime: "STRING_VALUE", - * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2", + * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1", * // ThroughputCapacity: Number("int"), * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // DiskIopsConfiguration: { @@ -444,6 +452,12 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * // Iops: Number("long"), * // }, * // RootVolumeId: "STRING_VALUE", + * // PreferredSubnetId: "STRING_VALUE", + * // EndpointIpAddressRange: "STRING_VALUE", + * // RouteTableIds: [ + * // "STRING_VALUE", + * // ], + * // EndpointIpAddress: "STRING_VALUE", * // }, * // }, * // FailureDetails: { @@ -589,14 +603,17 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * // CopyTagsToBackups: true || false, * // CopyTagsToVolumes: true || false, * // DailyAutomaticBackupStartTime: "STRING_VALUE", - * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2", + * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1", * // ThroughputCapacity: Number("int"), * // WeeklyMaintenanceStartTime: "STRING_VALUE", - * // DiskIopsConfiguration: { - * // Mode: "AUTOMATIC" || "USER_PROVISIONED", - * // Iops: Number("long"), - * // }, + * // DiskIopsConfiguration: "Creates an Amazon FSx for Lustre data repository task. You use data repository tasks
- * to perform bulk operations between your Amazon FSx file system and its linked data
- * repositories. An example of a data repository task is exporting any data and metadata
- * changes, including POSIX metadata, to files, directories, and symbolic links (symlinks)
- * from your FSx file system to a linked data repository. A CreateDataRepositoryTask
- * operation will fail if a data repository is not linked to the FSx file system. To learn
- * more about data repository tasks, see
+ *
Creates an Amazon FSx for Lustre data repository task.
+ * A CreateDataRepositoryTask
operation will fail if a data
+ * repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your + * FSx for Lustre file system and its linked data repositories. An example of a data repository + * task is exporting any data and metadata changes, including POSIX metadata, to files, directories, + * and symbolic links (symlinks) from your FSx file system to a linked data repository.
+ *You use release data repository tasks to release data from your file system for files that + * are archived to S3. The metadata of released files remains on the file system so users or applications + * can still access released files by reading the files again, which will restore data from + * Amazon S3 to the FSx for Lustre file system.
+ *To learn more about data repository tasks, see * Data Repository Tasks. * To learn more about linking a data repository to your file system, see * Linking your file system to an S3 bucket.
@@ -72,6 +77,12 @@ export interface CreateDataRepositoryTaskCommandOutput extends CreateDataReposit * }, * ], * CapacityToRelease: Number("long"), + * ReleaseConfiguration: { // ReleaseConfiguration + * DurationSinceLastAccess: { // DurationSinceLastAccess + * Unit: "DAYS", + * Value: Number("long"), + * }, + * }, * }; * const command = new CreateDataRepositoryTaskCommand(input); * const response = await client.send(command); @@ -112,6 +123,12 @@ export interface CreateDataRepositoryTaskCommandOutput extends CreateDataReposit * // }, * // CapacityToRelease: Number("long"), * // FileCacheId: "STRING_VALUE", + * // ReleaseConfiguration: { // ReleaseConfiguration + * // DurationSinceLastAccess: { // DurationSinceLastAccess + * // Unit: "DAYS", + * // Value: Number("long"), + * // }, + * // }, * // }, * // }; * diff --git a/clients/client-fsx/src/commands/CreateFileSystemCommand.ts b/clients/client-fsx/src/commands/CreateFileSystemCommand.ts index f46e2e3a365f3..485807bbe62b6 100644 --- a/clients/client-fsx/src/commands/CreateFileSystemCommand.ts +++ b/clients/client-fsx/src/commands/CreateFileSystemCommand.ts @@ -138,6 +138,10 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * AuditLogDestination: "STRING_VALUE", * }, + * DiskIopsConfiguration: { // DiskIopsConfiguration + * Mode: "AUTOMATIC" || "USER_PROVISIONED", + * Iops: Number("long"), + * }, * }, * LustreConfiguration: { // CreateFileSystemLustreConfiguration * WeeklyMaintenanceStartTime: "STRING_VALUE", @@ -169,7 +173,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1", // required * EndpointIpAddressRange: "STRING_VALUE", * FsxAdminPassword: "STRING_VALUE", - * DiskIopsConfiguration: { // DiskIopsConfiguration + * DiskIopsConfiguration: { * Mode: "AUTOMATIC" || "USER_PROVISIONED", * Iops: Number("long"), * }, @@ -186,7 +190,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * CopyTagsToBackups: true || false, * CopyTagsToVolumes: true || false, * DailyAutomaticBackupStartTime: "STRING_VALUE", - * DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2", // required + * DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1", // required * ThroughputCapacity: Number("int"), // required * WeeklyMaintenanceStartTime: "STRING_VALUE", * DiskIopsConfiguration: { @@ -218,6 +222,11 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * CopyTagsToSnapshots: true || false, * ReadOnly: true || false, * }, + * PreferredSubnetId: "STRING_VALUE", + * EndpointIpAddressRange: "STRING_VALUE", + * RouteTableIds: [ + * "STRING_VALUE", + * ], * }, * }; * const command = new CreateFileSystemCommand(input); @@ -284,6 +293,10 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * // FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * // AuditLogDestination: "STRING_VALUE", * // }, + * // DiskIopsConfiguration: { // DiskIopsConfiguration + * // Mode: "AUTOMATIC" || "USER_PROVISIONED", + * // Iops: Number("long"), + * // }, * // }, * // LustreConfiguration: { // LustreFileSystemConfiguration * // WeeklyMaintenanceStartTime: "STRING_VALUE", @@ -318,7 +331,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * // }, * // AdministrativeActions: [ // AdministrativeActions * // { // AdministrativeAction - * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE", + * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION", * // ProgressPercent: Number("int"), * // RequestTime: new Date("TIMESTAMP"), * // Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING", @@ -383,6 +396,10 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * // FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * // AuditLogDestination: "STRING_VALUE", * // }, + * // DiskIopsConfiguration: { + * // Mode: "AUTOMATIC" || "USER_PROVISIONED", + * // Iops: Number("long"), + * // }, * // }, * // LustreConfiguration: { * // WeeklyMaintenanceStartTime: "STRING_VALUE", @@ -417,7 +434,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * // }, * // AdministrativeActions: [ * // { - * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE", + * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION", * // ProgressPercent: Number("int"), * // RequestTime: new Date("TIMESTAMP"), * // Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING", @@ -550,7 +567,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * // ], * // }, * // }, - * // DiskIopsConfiguration: { // DiskIopsConfiguration + * // DiskIopsConfiguration: { * // Mode: "AUTOMATIC" || "USER_PROVISIONED", * // Iops: Number("long"), * // }, @@ -568,7 +585,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * // CopyTagsToBackups: true || false, * // CopyTagsToVolumes: true || false, * // DailyAutomaticBackupStartTime: "STRING_VALUE", - * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2", + * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1", * // ThroughputCapacity: Number("int"), * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // DiskIopsConfiguration: { @@ -576,6 +593,12 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * // Iops: Number("long"), * // }, * // RootVolumeId: "STRING_VALUE", + * // PreferredSubnetId: "STRING_VALUE", + * // EndpointIpAddressRange: "STRING_VALUE", + * // RouteTableIds: [ + * // "STRING_VALUE", + * // ], + * // EndpointIpAddress: "STRING_VALUE", * // }, * // }, * // FailureDetails: { @@ -721,14 +744,17 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * // CopyTagsToBackups: true || false, * // CopyTagsToVolumes: true || false, * // DailyAutomaticBackupStartTime: "STRING_VALUE", - * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2", + * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1", * // ThroughputCapacity: Number("int"), * // WeeklyMaintenanceStartTime: "STRING_VALUE", - * // DiskIopsConfiguration: { - * // Mode: "AUTOMATIC" || "USER_PROVISIONED", - * // Iops: Number("long"), - * // }, + * // DiskIopsConfiguration: "
+ * StorageType
+ *
* ThroughputCapacity
*
+ * DiskIopsConfiguration
+ *
* WeeklyMaintenanceStartTime
*
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx + *
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx * automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per * GB of storage. The configuration consists of the total number of provisioned SSD IOPS * and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
@@ -869,6 +872,7 @@ export interface OntapFileSystemConfiguration { * @enum */ export const OpenZFSDeploymentType = { + MULTI_AZ_1: "MULTI_AZ_1", SINGLE_AZ_1: "SINGLE_AZ_1", SINGLE_AZ_2: "SINGLE_AZ_2", } as const; @@ -925,7 +929,7 @@ export interface OpenZFSFileSystemConfiguration { /** * @public - *Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 SINGLE_AZ_1
and SINGLE_AZ_2
.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1
, SINGLE_AZ_1
, and SINGLE_AZ_2
.
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx + *
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx * automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per * GB of storage. The configuration consists of the total number of provisioned SSD IOPS * and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
@@ -962,6 +966,37 @@ export interface OpenZFSFileSystemConfiguration { *The ID of the root volume of the OpenZFS file system.
*/ RootVolumeId?: string; + + /** + * @public + *Required when DeploymentType
is set to MULTI_AZ_1
. This
+ * specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your + * file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx + * selects an available /28 IP address range for you from one of the VPC's CIDR ranges. + * You can have overlapping endpoint IP addresses for file systems deployed in the + * same VPC/route tables.
+ */ + EndpointIpAddressRange?: string; + + /** + * @public + *(Multi-AZ only) The VPC route tables in which your file system's endpoints are + * created.
+ */ + RouteTableIds?: string[]; + + /** + * @public + *The IP address of the endpoint + * that is used to access data or to manage the file system.
+ */ + EndpointIpAddress?: string; } /** @@ -1158,7 +1193,7 @@ export interface WindowsAuditLogConfiguration { * Amazon Kinesis Data Firehose delivery stream ARN. *The name of the Amazon CloudWatch Logs log group must begin with
* the /aws/fsx
prefix. The name of the Amazon Kinesis Data
- * Firehouse delivery stream must begin with the aws-fsx
prefix.
aws-fsx
prefix.
* The destination ARN (either CloudWatch Logs log group or Kinesis * Data Firehose delivery stream) must be in the same Amazon Web Services partition, * Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
@@ -1378,6 +1413,14 @@ export interface WindowsFileSystemConfiguration { * file system. */ AuditLogConfiguration?: WindowsAuditLogConfiguration; + + /** + * @public + *The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. + * By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional + * IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
+ */ + DiskIopsConfiguration?: DiskIopsConfiguration; } /** @@ -1700,7 +1743,7 @@ export interface SnaplockConfiguration { * if they have active retention periods.PERMANENTLY_DISABLED
is a terminal state.
* If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default
* value is DISABLED
.
- * For more information, see Privileged delete.
+ *For more information, see Privileged delete.
*/ PrivilegedDelete?: PrivilegedDelete | string; @@ -1727,7 +1770,7 @@ export interface SnaplockConfiguration { *ENTERPRISE
: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users
* before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity
* and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see
- * SnapLock Enterprise.
+ * SnapLock Enterprise.
*
*
*/
@@ -3572,6 +3615,88 @@ export interface CreateDataRepositoryAssociationResponse {
Association?: DataRepositoryAssociation;
}
+/**
+ * @public
+ * @enum
+ */
+export const Unit = {
+ DAYS: "DAYS",
+} as const;
+
+/**
+ * @public
+ */
+export type Unit = (typeof Unit)[keyof typeof Unit];
+
+/**
+ * @public
+ * Defines the minimum amount of time since last access for a + * file to be eligible for release. Only archived files that were + * last accessed or modified before this point-in-time are eligible + * to be released from the Amazon FSx for Lustre file system.
+ */ +export interface DurationSinceLastAccess { + /** + * @public + *The unit of time used by the Value
parameter to
+ * determine if a file can be released, based on when it was last
+ * accessed. DAYS
is the only supported value. This
+ * is a required parameter.
An integer that represents the minimum amount of time (in days)
+ * since a file was last accessed in the file system. Only archived files
+ * with a MAX(atime, ctime, mtime)
timestamp that is more than
+ * this amount of time in the past (relative to the task create time)
+ * will be released. The default of Value
is 0
.
+ * This is a required parameter.
If an archived file meets the last accessed time criteria,
+ * its file or directory path must also be specified in the Paths
+ * parameter of the operation
+ * in order for the file to be released.
The configuration that specifies a minimum amount of time since + * last access for an archived file to be eligible for release from an + * Amazon FSx for Lustre file system. Only files that were last + * accessed before this point-in-time can be released. For example, if + * you specify a last accessed time criteria of 9 days, only files that + * were last accessed 9.00001 or more days ago can be released.
+ *Only file data that has been archived can be released. Files that + * have not yet been archived, such as new or changed files that have + * not been exported, are not eligible for release. When files are + * released, their metadata stays on the file system, so they + * can still be accessed later. Users and applications can access a + * released file by reading the file again, which restores data from + * Amazon S3 to the FSx for Lustre file system.
+ *If a file meets the last accessed time criteria, its
+ * file or directory path must also be specified with the
+ * Paths
parameter of the
+ * operation in order
+ * for the file to be released.
Defines the point-in-time since an archived file was last accessed, + * in order for that file to be eligible for release. Only files that were + * last accessed before this point-in-time are eligible to be released from + * the file system.
+ */ + DurationSinceLastAccess?: DurationSinceLastAccess; +} + /** * @public * @enum @@ -3663,16 +3788,42 @@ export interface CreateDataRepositoryTaskRequest { /** * @public *Specifies the type of data repository task to create.
+ *
+ * EXPORT_TO_REPOSITORY
tasks export from your
+ * Amazon FSx for Lustre file system to a linked data repository.
+ * IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata
+ * changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
+ * RELEASE_DATA_FROM_FILESYSTEM
tasks release files in
+ * your Amazon FSx for Lustre file system that are archived and that meet
+ * your specified release criteria.
+ * AUTO_RELEASE_DATA
tasks automatically release files from
+ * an Amazon File Cache resource.
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.
+ * If a path that you provide isn't valid, the task fails. If you don't provide + * paths, the default behavior is to export all files to S3 (for export tasks), import + * all files from S3 (for import tasks), or release all archived files that meet the + * last accessed time criteria (for release tasks). *For export tasks, the list contains paths on the Amazon FSx file system + *
For export tasks, the list contains paths on the FSx for Lustre 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 /mnt/fsx
and
@@ -3681,9 +3832,22 @@ export interface CreateDataRepositoryTaskRequest {
*
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.
+ * 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
- * s3://myBucket/myPrefix
(where myPrefix
is optional).
s3://myBucket/myPrefix
(where myPrefix
is optional).
+ *
+ * For release tasks, the list contains directory or file paths on the + * FSx for Lustre file system from which to release archived files. If a directory is + * specified, files within the directory are released. If a file path is specified, + * only that file is released. To release all archived files in the file system, + * specify a forward slash (/) as the path.
+ *A file must also meet the last accessed time criteria + * specified in for the + * file to be released.
+ *AUTO_RELEASE_DATA
task that automatically releases files from the cache.
*/
CapacityToRelease?: number;
+
+ /**
+ * @public
+ * The configuration that specifies the last accessed time criteria for files + * that will be released from an Amazon FSx for Lustre file system.
+ */ + ReleaseConfiguration?: ReleaseConfiguration; } /** @@ -3780,10 +3951,25 @@ export interface DataRepositoryTaskStatus { /** * @public - *A description of the data repository task. You use data repository tasks - * to perform bulk transfer operations between an Amazon FSx for Lustre file system - * and a linked data repository. An Amazon File Cache resource uses a task to - * automatically release files from the cache.
+ *A description of the data repository task.
+ *You use import and export data repository tasks to perform + * bulk transfer operations between an Amazon FSx for Lustre file system + * and a linked data repository.
+ *You use release data repository tasks to release archived files + * from your Amazon FSx for Lustre file system.
+ *An Amazon File Cache resource uses a task to automatically + * release files from the cache.
+ *To learn more about data repository tasks, see + * Data Repository Tasks. + *
*/ export interface DataRepositoryTask { /** @@ -3847,12 +4033,14 @@ export interface DataRepositoryTask { * *
- * AUTO_RELEASE_DATA
tasks automatically release files from
- * an Amazon File Cache resource.
RELEASE_DATA_FROM_FILESYSTEM
tasks release files in
+ * your Amazon FSx for Lustre file system that are archived and that meet
+ * your specified release criteria.
*
- * RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
AUTO_RELEASE_DATA
tasks automatically release files from
+ * an Amazon File Cache resource.
* The system-generated, unique ID of the cache.
*/ FileCacheId?: string; + + /** + * @public + *The configuration that specifies the last accessed time criteria for files + * that will be released from an Amazon FSx for Lustre file system.
+ */ + ReleaseConfiguration?: ReleaseConfiguration; } /** @@ -5193,7 +5388,12 @@ export interface CreateFileSystemOpenZFSConfiguration { *
- * SINGLE_AZ_1
- (Default) Creates file systems with throughput capacities of 64 - 4,096 MBps.
+ * MULTI_AZ_1
- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs).
+ * Multi_AZ_1
is available in the following Amazon Web Services Regions:
+ * SINGLE_AZ_1
- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s.
* Single_AZ_1
is available in all Amazon Web Services Regions where Amazon FSx
* for OpenZFS is available.
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx + *
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx * automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per * GB of storage. The configuration consists of the total number of provisioned SSD IOPS * and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
@@ -5253,6 +5453,31 @@ export interface CreateFileSystemOpenZFSConfiguration { * file system. All volumes are children of the root volume. */ RootVolumeConfiguration?: OpenZFSCreateRootVolumeConfiguration; + + /** + * @public + *Required when DeploymentType
is set to MULTI_AZ_1
. This specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your + * file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx + * selects an available /28 IP address range for you from one of the VPC's CIDR ranges. + * You can have overlapping endpoint IP addresses for file systems deployed in the + * same VPC/route tables.
+ */ + EndpointIpAddressRange?: string; + + /** + * @public + *(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your + * file system's endpoints will be created. You should specify all VPC route tables + * associated with the subnets in which your clients are located. By default, Amazon FSx + * selects your VPC's default route table.
+ */ + RouteTableIds?: string[]; } /** @@ -5329,7 +5554,7 @@ export interface WindowsAuditLogCreateConfiguration { *The name of the Amazon CloudWatch Logs log group must begin with
* the /aws/fsx
prefix. The name of the Amazon Kinesis Data
- * Firehouse delivery stream must begin with the aws-fsx
prefix.
aws-fsx
prefix.
* If you do not provide a destination in AuditLogDestination
,
@@ -5556,6 +5781,14 @@ export interface CreateFileSystemWindowsConfiguration {
* file system.
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. + * By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional + * IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
+ */ + DiskIopsConfiguration?: DiskIopsConfiguration; } /** @@ -6459,7 +6692,7 @@ export interface CreateSnaplockConfiguration { * If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default * value isDISABLED
.
* For more information, see - * Privileged delete.
+ * Privileged delete. */ PrivilegedDelete?: PrivilegedDelete | string; @@ -6487,7 +6720,7 @@ export interface CreateSnaplockConfiguration { *ENTERPRISE
: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users
* before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity
* and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see
- * SnapLock Enterprise.
+ * SnapLock Enterprise.
* fsx:BypassSnaplockEnterpriseRetention
is also
* required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is false
.
* For more information, see - * - * Deleting a SnapLock volume - * .
+ * + * Deleting a SnapLock volume. */ BypassSnaplockEnterpriseRetention?: boolean; } @@ -9097,12 +9329,28 @@ export interface UpdateFileSystemOpenZFSConfiguration { /** * @public - *The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx + *
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx * automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per * GB of storage. The configuration consists of the total number of provisioned SSD IOPS * and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
*/ DiskIopsConfiguration?: DiskIopsConfiguration; + + /** + * @public + *(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables + * to associate (add) with your Amazon FSx for OpenZFS file system.
+ */ + AddRouteTableIds?: string[]; + + /** + * @public + *(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) + * route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use + * the API operation to retrieve the + * list of VPC route table IDs for a file system.
+ */ + RemoveRouteTableIds?: string[]; } /** @@ -9207,6 +9455,14 @@ export interface UpdateFileSystemWindowsConfiguration { * file system.. */ AuditLogConfiguration?: WindowsAuditLogCreateConfiguration; + + /** + * @public + *The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. + * By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional + * IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
+ */ + DiskIopsConfiguration?: DiskIopsConfiguration; } /** @@ -9295,6 +9551,12 @@ export interface UpdateFileSystemRequest { *The configuration updates for an FSx for OpenZFS file system.
*/ OpenZFSConfiguration?: UpdateFileSystemOpenZFSConfiguration; + + /** + * @public + *Specifies the file system's storage type.
+ */ + StorageType?: StorageType | string; } /** @@ -9416,7 +9678,7 @@ export interface UpdateSnaplockConfiguration { * If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default * value isDISABLED
.
* For more information, see - * Privileged delete.
+ * Privileged delete. */ PrivilegedDelete?: PrivilegedDelete | string; @@ -9656,6 +9918,19 @@ export interface AdministrativeAction { * *
+ * THROUGHPUT_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
+ * task to increase a file system's throughput capacity has been completed
+ * successfully, a THROUGHPUT_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the
+ * ProgressPercent
property. When
+ * THROUGHPUT_OPTIMIZATION
has been completed successfully, the
+ * parent FILE_SYSTEM_UPDATE
action status changes to
+ * COMPLETED
. For more information, see Managing
+ * throughput capacity in the Amazon FSx for Windows
+ * File Server User Guide.
* STORAGE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
* task to increase a file system's storage capacity has been completed
* successfully, a STORAGE_OPTIMIZATION
task starts.
+ * IOPS_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
+ * task to increase a file system's throughput capacity has been completed
+ * successfully, a IOPS_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the
+ * ProgressPercent
property. When
+ * IOPS_OPTIMIZATION
has been completed successfully, the
+ * parent FILE_SYSTEM_UPDATE
action status changes to
+ * COMPLETED
. For more information, see Managing
+ * provisioned SSD IOPS in the Amazon FSx for Windows
+ * File Server User Guide.
+ * STORAGE_TYPE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
+ * task to increase a file system's throughput capacity has been completed
+ * successfully, a STORAGE_TYPE_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the
+ * ProgressPercent
property. When
+ * STORAGE_TYPE_OPTIMIZATION
has been completed successfully, the
+ * parent FILE_SYSTEM_UPDATE
action status changes to
+ * COMPLETED
.
* VOLUME_UPDATE
- A volume update to an Amazon FSx for NetApp ONTAP or
* Amazon FSx for OpenZFS volume initiated from the Amazon FSx
* console, API (UpdateVolume
), or CLI
diff --git a/clients/client-fsx/src/protocols/Aws_json1_1.ts b/clients/client-fsx/src/protocols/Aws_json1_1.ts
index 8b264ecc4ec29..54e41a64579d0 100644
--- a/clients/client-fsx/src/protocols/Aws_json1_1.ts
+++ b/clients/client-fsx/src/protocols/Aws_json1_1.ts
@@ -212,6 +212,7 @@ import {
DescribeVolumesResponse,
DisassociateFileSystemAliasesRequest,
DiskIopsConfiguration,
+ DurationSinceLastAccess,
EventType,
FileCache,
FileCacheCreating,
@@ -244,6 +245,7 @@ import {
OpenZFSCreateRootVolumeConfiguration,
OpenZFSNfsExport,
OpenZFSUserOrGroupQuota,
+ ReleaseConfiguration,
ReleaseFileSystemNfsV3LocksRequest,
ReleaseFileSystemNfsV3LocksResponse,
ResourceDoesNotSupportTagging,
@@ -3843,6 +3845,7 @@ const se_CreateDataRepositoryTaskRequest = (input: CreateDataRepositoryTaskReque
ClientRequestToken: [true, (_) => _ ?? generateIdempotencyToken()],
FileSystemId: [],
Paths: _json,
+ ReleaseConfiguration: _json,
Report: _json,
Tags: _json,
Type: [],
@@ -4143,6 +4146,8 @@ const se_DisassociateFileSystemAliasesRequest = (
// se_DnsIps omitted.
+// se_DurationSinceLastAccess omitted.
+
// se_EventTypes omitted.
// se_FileCacheDataRepositoryAssociation omitted.
@@ -4185,6 +4190,8 @@ const se_DisassociateFileSystemAliasesRequest = (
// se_OpenZFSUserOrGroupQuota omitted.
+// se_ReleaseConfiguration omitted.
+
/**
* serializeAws_json1_1ReleaseFileSystemNfsV3LocksRequest
*/
@@ -4307,6 +4314,7 @@ const se_UpdateFileSystemRequest = (input: UpdateFileSystemRequest, context: __S
OntapConfiguration: _json,
OpenZFSConfiguration: _json,
StorageCapacity: [],
+ StorageType: [],
WindowsConfiguration: _json,
});
};
@@ -4636,6 +4644,7 @@ const de_DataRepositoryTask = (output: any, context: __SerdeContext): DataReposi
FileSystemId: __expectString,
Lifecycle: __expectString,
Paths: _json,
+ ReleaseConfiguration: _json,
Report: _json,
ResourceARN: __expectString,
StartTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
@@ -4800,6 +4809,8 @@ const de_DescribeVolumesResponse = (output: any, context: __SerdeContext): Descr
// de_DnsIps omitted.
+// de_DurationSinceLastAccess omitted.
+
// de_EventTypes omitted.
/**
@@ -4995,6 +5006,8 @@ const de_FileSystems = (output: any, context: __SerdeContext): FileSystem[] => {
// de_OpenZFSVolumeConfiguration omitted.
+// de_ReleaseConfiguration omitted.
+
/**
* deserializeAws_json1_1ReleaseFileSystemNfsV3LocksResponse
*/
diff --git a/codegen/sdk-codegen/aws-models/fsx.json b/codegen/sdk-codegen/aws-models/fsx.json
index 6e36ddc8523a6..5ebaf19802b2d 100644
--- a/codegen/sdk-codegen/aws-models/fsx.json
+++ b/codegen/sdk-codegen/aws-models/fsx.json
@@ -242,52 +242,56 @@
"type": "error"
},
{
- "conditions": [],
- "type": "tree",
- "rules": [
+ "conditions": [
{
- "conditions": [
+ "fn": "booleanEquals",
+ "argv": [
{
- "fn": "booleanEquals",
- "argv": [
- {
- "ref": "UseDualStack"
- },
- true
- ]
- }
- ],
- "error": "Invalid Configuration: Dualstack and custom endpoint are not supported",
- "type": "error"
- },
- {
- "conditions": [],
- "endpoint": {
- "url": {
- "ref": "Endpoint"
+ "ref": "UseDualStack"
},
- "properties": {},
- "headers": {}
- },
- "type": "endpoint"
+ true
+ ]
}
- ]
+ ],
+ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported",
+ "type": "error"
+ },
+ {
+ "conditions": [],
+ "endpoint": {
+ "url": {
+ "ref": "Endpoint"
+ },
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
}
]
},
{
- "conditions": [],
+ "conditions": [
+ {
+ "fn": "isSet",
+ "argv": [
+ {
+ "ref": "Region"
+ }
+ ]
+ }
+ ],
"type": "tree",
"rules": [
{
"conditions": [
{
- "fn": "isSet",
+ "fn": "aws.partition",
"argv": [
{
"ref": "Region"
}
- ]
+ ],
+ "assign": "PartitionResult"
}
],
"type": "tree",
@@ -295,13 +299,22 @@
{
"conditions": [
{
- "fn": "aws.partition",
+ "fn": "booleanEquals",
"argv": [
{
- "ref": "Region"
- }
- ],
- "assign": "PartitionResult"
+ "ref": "UseFIPS"
+ },
+ true
+ ]
+ },
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseDualStack"
+ },
+ true
+ ]
}
],
"type": "tree",
@@ -311,224 +324,175 @@
{
"fn": "booleanEquals",
"argv": [
+ true,
{
- "ref": "UseFIPS"
- },
- true
+ "fn": "getAttr",
+ "argv": [
+ {
+ "ref": "PartitionResult"
+ },
+ "supportsFIPS"
+ ]
+ }
]
},
{
"fn": "booleanEquals",
"argv": [
+ true,
{
- "ref": "UseDualStack"
- },
- true
- ]
- }
- ],
- "type": "tree",
- "rules": [
- {
- "conditions": [
- {
- "fn": "booleanEquals",
+ "fn": "getAttr",
"argv": [
- true,
{
- "fn": "getAttr",
- "argv": [
- {
- "ref": "PartitionResult"
- },
- "supportsFIPS"
- ]
- }
- ]
- },
- {
- "fn": "booleanEquals",
- "argv": [
- true,
- {
- "fn": "getAttr",
- "argv": [
- {
- "ref": "PartitionResult"
- },
- "supportsDualStack"
- ]
- }
- ]
- }
- ],
- "type": "tree",
- "rules": [
- {
- "conditions": [],
- "type": "tree",
- "rules": [
- {
- "conditions": [],
- "endpoint": {
- "url": "https://fsx-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",
- "properties": {},
- "headers": {}
- },
- "type": "endpoint"
- }
+ "ref": "PartitionResult"
+ },
+ "supportsDualStack"
]
}
]
- },
+ }
+ ],
+ "type": "tree",
+ "rules": [
{
"conditions": [],
- "error": "FIPS and DualStack are enabled, but this partition does not support one or both",
- "type": "error"
+ "endpoint": {
+ "url": "https://fsx-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
}
]
},
+ {
+ "conditions": [],
+ "error": "FIPS and DualStack are enabled, but this partition does not support one or both",
+ "type": "error"
+ }
+ ]
+ },
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseFIPS"
+ },
+ true
+ ]
+ }
+ ],
+ "type": "tree",
+ "rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
+ true,
{
- "ref": "UseFIPS"
- },
- true
- ]
- }
- ],
- "type": "tree",
- "rules": [
- {
- "conditions": [
- {
- "fn": "booleanEquals",
+ "fn": "getAttr",
"argv": [
- true,
{
- "fn": "getAttr",
- "argv": [
- {
- "ref": "PartitionResult"
- },
- "supportsFIPS"
- ]
- }
- ]
- }
- ],
- "type": "tree",
- "rules": [
- {
- "conditions": [],
- "type": "tree",
- "rules": [
- {
- "conditions": [],
- "endpoint": {
- "url": "https://fsx-fips.{Region}.{PartitionResult#dnsSuffix}",
- "properties": {},
- "headers": {}
- },
- "type": "endpoint"
- }
+ "ref": "PartitionResult"
+ },
+ "supportsFIPS"
]
}
]
- },
+ }
+ ],
+ "type": "tree",
+ "rules": [
{
"conditions": [],
- "error": "FIPS is enabled but this partition does not support FIPS",
- "type": "error"
+ "endpoint": {
+ "url": "https://fsx-fips.{Region}.{PartitionResult#dnsSuffix}",
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
}
]
},
+ {
+ "conditions": [],
+ "error": "FIPS is enabled but this partition does not support FIPS",
+ "type": "error"
+ }
+ ]
+ },
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseDualStack"
+ },
+ true
+ ]
+ }
+ ],
+ "type": "tree",
+ "rules": [
{
"conditions": [
{
"fn": "booleanEquals",
"argv": [
+ true,
{
- "ref": "UseDualStack"
- },
- true
- ]
- }
- ],
- "type": "tree",
- "rules": [
- {
- "conditions": [
- {
- "fn": "booleanEquals",
+ "fn": "getAttr",
"argv": [
- true,
{
- "fn": "getAttr",
- "argv": [
- {
- "ref": "PartitionResult"
- },
- "supportsDualStack"
- ]
- }
- ]
- }
- ],
- "type": "tree",
- "rules": [
- {
- "conditions": [],
- "type": "tree",
- "rules": [
- {
- "conditions": [],
- "endpoint": {
- "url": "https://fsx.{Region}.{PartitionResult#dualStackDnsSuffix}",
- "properties": {},
- "headers": {}
- },
- "type": "endpoint"
- }
+ "ref": "PartitionResult"
+ },
+ "supportsDualStack"
]
}
]
- },
- {
- "conditions": [],
- "error": "DualStack is enabled but this partition does not support DualStack",
- "type": "error"
}
- ]
- },
- {
- "conditions": [],
+ ],
"type": "tree",
"rules": [
{
"conditions": [],
"endpoint": {
- "url": "https://fsx.{Region}.{PartitionResult#dnsSuffix}",
+ "url": "https://fsx.{Region}.{PartitionResult#dualStackDnsSuffix}",
"properties": {},
"headers": {}
},
"type": "endpoint"
}
]
+ },
+ {
+ "conditions": [],
+ "error": "DualStack is enabled but this partition does not support DualStack",
+ "type": "error"
}
]
+ },
+ {
+ "conditions": [],
+ "endpoint": {
+ "url": "https://fsx.{Region}.{PartitionResult#dnsSuffix}",
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
}
]
- },
- {
- "conditions": [],
- "error": "Invalid Configuration: Missing Region",
- "type": "error"
}
]
+ },
+ {
+ "conditions": [],
+ "error": "Invalid Configuration: Missing Region",
+ "type": "error"
}
]
},
@@ -1408,10 +1372,28 @@
"traits": {
"smithy.api#enumValue": "VOLUME_RESTORE"
}
+ },
+ "THROUGHPUT_OPTIMIZATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "THROUGHPUT_OPTIMIZATION"
+ }
+ },
+ "IOPS_OPTIMIZATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "IOPS_OPTIMIZATION"
+ }
+ },
+ "STORAGE_TYPE_OPTIMIZATION": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "STORAGE_TYPE_OPTIMIZATION"
+ }
}
},
"traits": {
- "smithy.api#documentation": "
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE
- A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem
), or CLI\n (update-file-system
).
\n STORAGE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION
task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent
property. When\n STORAGE_OPTIMIZATION
has been completed successfully, the\n parent FILE_SYSTEM_UPDATE
action status changes to\n COMPLETED
. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n and throughput capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION
- A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION
- A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n VOLUME_UPDATE
- A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume
), or CLI\n (update-volume
).
\n VOLUME_RESTORE
- An Amazon FSx for OpenZFS volume\n is returned to the state saved by the specified snapshot, initiated from an\n API (RestoreVolumeFromSnapshot
) or CLI\n (restore-volume-from-snapshot
).
\n SNAPSHOT_UPDATE
- A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot
), or CLI (update-snapshot
).
\n RELEASE_NFS_V3_LOCKS
- Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE
- A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem
), or CLI\n (update-file-system
).
\n THROUGHPUT_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
\n task to increase a file system's throughput capacity has been completed\n successfully, a THROUGHPUT_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the\n ProgressPercent
property. When\n THROUGHPUT_OPTIMIZATION
has been completed successfully, the\n parent FILE_SYSTEM_UPDATE
action status changes to\n COMPLETED
. For more information, see Managing\n throughput capacity in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION
task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent
property. When\n STORAGE_OPTIMIZATION
has been completed successfully, the\n parent FILE_SYSTEM_UPDATE
action status changes to\n COMPLETED
. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n and throughput capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION
- A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION
- A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n IOPS_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
\n task to increase a file system's throughput capacity has been completed\n successfully, a IOPS_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the\n ProgressPercent
property. When\n IOPS_OPTIMIZATION
has been completed successfully, the\n parent FILE_SYSTEM_UPDATE
action status changes to\n COMPLETED
. For more information, see Managing\n provisioned SSD IOPS in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_TYPE_OPTIMIZATION
- After the FILE_SYSTEM_UPDATE
\n task to increase a file system's throughput capacity has been completed\n successfully, a STORAGE_TYPE_OPTIMIZATION
task starts.
You can track the storage-optimization progress using the\n ProgressPercent
property. When\n STORAGE_TYPE_OPTIMIZATION
has been completed successfully, the\n parent FILE_SYSTEM_UPDATE
action status changes to\n COMPLETED
.
\n VOLUME_UPDATE
- A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume
), or CLI\n (update-volume
).
\n VOLUME_RESTORE
- An Amazon FSx for OpenZFS volume\n is returned to the state saved by the specified snapshot, initiated from an\n API (RestoreVolumeFromSnapshot
) or CLI\n (restore-volume-from-snapshot
).
\n SNAPSHOT_UPDATE
- A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot
), or CLI (update-snapshot
).
\n RELEASE_NFS_V3_LOCKS
- Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the \n PENDING
or EXECUTING
state. When you cancel a task, Amazon FSx does the following.
Any files that FSx has already exported are not reverted.
\nFSx continues to export any files that are \"in-flight\" when the cancel operation is received.
\nFSx does not export any files that have not yet been exported.
\nCancels an existing Amazon FSx for Lustre data repository task if that task is in either the \n PENDING
or EXECUTING
state. When you cancel am export task, Amazon FSx\n does the following.
Any files that FSx has already exported are not reverted.
\nFSx continues to export any files that are in-flight when the cancel operation is received.
\nFSx does not export any files that have not yet been exported.
\nFor a release task, Amazon FSx will stop releasing files upon cancellation. Any files that\n have already been released will remain in the released state.
", "smithy.api#idempotent": {} } }, @@ -2200,6 +2182,46 @@ ], "traits": { "smithy.api#documentation": "Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region\n (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five\n backup copy requests in progress to a single destination Region per account.
\nYou can use cross-Region backup copies for cross-Region disaster recovery. You can\n periodically take backups and copy them to another Region so that in the event of a\n disaster in the primary Region, you can restore from backup and recover availability\n quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently\n has three partitions: aws
(Standard Regions), aws-cn
(China\n Regions), and aws-us-gov
(Amazon Web Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within\n the same Region.
\nYou can use the SourceRegion
parameter to specify the Amazon Web Services Region\n from which the backup will be copied. For example, if you make the call from the\n us-west-1
Region and want to copy a backup from the us-east-2
\n Region, you specify us-east-2
in the SourceRegion
parameter\n to make a cross-Region copy. If you don't specify a Region, the backup copy is\n created in the same Region where the request is sent from (in-Region copy).
For more information about creating backup copies, see Copying backups\n in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User\n Guide, and Copying backups in the Amazon FSx for OpenZFS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To copy a backup", + "documentation": "This operation copies an Amazon FSx backup.", + "input": { + "SourceBackupId": "backup-03e3c82e0183b7b6b", + "SourceRegion": "us-east-2" + }, + "output": { + "Backup": { + "BackupId": "backup-0a3364eded1014b28", + "OwnerId": "123456789012", + "Lifecycle": "COPYING", + "Type": "USER_INITIATED", + "CreationTime": 1.617954808068e9, + "KmsKeyId": "arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28", + "Tags": [ + { + "Key": "Name", + "Value": "MyBackup" + } + ], + "FileSystem": { + "FileSystemId": "fs-0498eed5fe91001ec", + "FileSystemType": "LUSTRE", + "StorageCapacity": 2400, + "StorageType": "SSD", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66", + "LustreConfiguration": { + "WeeklyMaintenanceStartTime": "1:05:00", + "DeploymentType": "PERSISTENT_1", + "PerUnitStorageThroughput": 50, + "AutomaticBackupRetentionDays": 0 + } + } + } + } + } + ], "smithy.api#idempotent": {} } }, @@ -2477,7 +2499,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon FSx for Lustre data repository task. You use data repository tasks\n to perform bulk operations between your Amazon FSx file system and its linked data\n repositories. An example of a data repository task is exporting any data and metadata\n changes, including POSIX metadata, to files, directories, and symbolic links (symlinks)\n from your FSx file system to a linked data repository. A CreateDataRepositoryTask
\n operation will fail if a data repository is not linked to the FSx file system. To learn\n more about data repository tasks, see \n Data Repository Tasks. \n To learn more about linking a data repository to your file system, see \n Linking your file system to an S3 bucket.
Creates an Amazon FSx for Lustre data repository task.\n A CreateDataRepositoryTask
operation will fail if a data\n repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your\n FSx for Lustre file system and its linked data repositories. An example of a data repository\n task is exporting any data and metadata changes, including POSIX metadata, to files, directories,\n and symbolic links (symlinks) from your FSx file system to a linked data repository.
\nYou use release data repository tasks to release data from your file system for files that\n are archived to S3. The metadata of released files remains on the file system so users or applications\n can still access released files by reading the files again, which will restore data from\n Amazon S3 to the FSx for Lustre file system.
\nTo learn more about data repository tasks, see \n Data Repository Tasks. \n To learn more about linking a data repository to your file system, see \n Linking your file system to an S3 bucket.
", "smithy.api#idempotent": {} } }, @@ -2487,14 +2509,14 @@ "Type": { "target": "com.amazonaws.fsx#DataRepositoryTaskType", "traits": { - "smithy.api#documentation": "Specifies the type of data repository task to create.
", + "smithy.api#documentation": "Specifies the type of data repository task to create.
\n\n EXPORT_TO_REPOSITORY
tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n RELEASE_DATA_FROM_FILESYSTEM
tasks release files in\n your Amazon FSx for Lustre file system that are archived and that meet\n your specified release criteria.
\n AUTO_RELEASE_DATA
tasks automatically release files from\n an Amazon File Cache resource.
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.
\nFor 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 /mnt/fsx
and\n /mnt/fsx/path1
is a directory or file on the file system you want\n to export, then the path to provide is path1
.
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 s3://myBucket/myPrefix
(where myPrefix
is optional).
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 archived files that meet the\n last accessed time criteria (for release tasks).
\nFor 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 /mnt/fsx
and\n /mnt/fsx/path1
is a directory or file on the file system you want\n to export, then the path to provide is path1
.
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 s3://myBucket/myPrefix
(where myPrefix
is optional).\n
For release tasks, the list contains directory or file paths on the\n FSx for Lustre file system from which to release archived 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 archived files in the file system,\n specify a forward slash (/) as the path.
\nA file must also meet the last accessed time criteria\n specified in for the\n file to be released.
\nSpecifies the amount of data to release, in GiB, by an Amazon File Cache\n AUTO_RELEASE_DATA
task that automatically releases files from the cache.
The configuration that specifies the last accessed time criteria for files\n that will be released from an Amazon FSx for Lustre file system.
" + } } }, "traits": { @@ -3064,7 +3092,7 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OpenZFSDeploymentType", "traits": { - "smithy.api#documentation": "Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n SINGLE_AZ_1
- (Default) Creates file systems with throughput capacities of 64 - 4,096 MBps.\n Single_AZ_1
is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available.
\n SINGLE_AZ_2
- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache. Single_AZ_2
is available only in the US East (N. Virginia), US East (Ohio), \n US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", + "smithy.api#documentation": "Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n MULTI_AZ_1
- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs).\n Multi_AZ_1
is available in the following Amazon Web Services Regions:
\n SINGLE_AZ_1
- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s.\n Single_AZ_1
is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available.
\n SINGLE_AZ_2
- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache. Single_AZ_2
is available only in the US East (N. Virginia), US East (Ohio), \n US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", "smithy.api#required": {} } }, @@ -3086,6 +3114,24 @@ "traits": { "smithy.api#documentation": "The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS\n file system. All volumes are children of the root volume.
" } + }, + "PreferredSubnetId": { + "target": "com.amazonaws.fsx#SubnetId", + "traits": { + "smithy.api#documentation": "Required when DeploymentType
is set to MULTI_AZ_1
. This specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\n selects an available /28 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.
" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.fsx#RouteTableIds", + "traits": { + "smithy.api#documentation": "(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your\n file system's endpoints will be created. You should specify all VPC route tables\n associated with the subnets in which your clients are located. By default, Amazon FSx\n selects your VPC's default route table.
" + } } }, "traits": { @@ -3255,6 +3301,12 @@ "traits": { "smithy.api#documentation": "The configuration that Amazon FSx for Windows File Server uses to audit and log\n user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server\n file system.
" } + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration", + "traits": { + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.\n By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional\n IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" + } } }, "traits": { @@ -3436,7 +3488,7 @@ "PrivilegedDelete": { "target": "com.amazonaws.fsx#PrivilegedDelete", "traits": { - "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even \n if they have active retention periods. PERMANENTLY_DISABLED
is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED
.
For more information, see \n Privileged delete.
" + "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even \n if they have active retention periods. PERMANENTLY_DISABLED
is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED
.
For more information, see \n Privileged delete.
" } }, "RetentionPeriod": { @@ -3448,7 +3500,7 @@ "SnaplockType": { "target": "com.amazonaws.fsx#SnaplockType", "traits": { - "smithy.api#documentation": "Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. \n You can choose one of the following retention modes:
\n\n COMPLIANCE
: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted \n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect \n against ransomware attacks. For more information, \n see SnapLock Compliance.
\n ENTERPRISE
: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users \n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity \n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see \n SnapLock Enterprise.
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. \n You can choose one of the following retention modes:
\n\n COMPLIANCE
: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted \n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect \n against ransomware attacks. For more information, \n see SnapLock Compliance.
\n ENTERPRISE
: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users \n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity \n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see \n SnapLock Enterprise.
The type of data repository task.
\n\n EXPORT_TO_REPOSITORY
tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n AUTO_RELEASE_DATA
tasks automatically release files from\n an Amazon File Cache resource.
\n RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
The type of data repository task.
\n\n EXPORT_TO_REPOSITORY
tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n RELEASE_DATA_FROM_FILESYSTEM
tasks release files in\n your Amazon FSx for Lustre file system that are archived and that meet\n your specified release criteria.
\n AUTO_RELEASE_DATA
tasks automatically release files from\n an Amazon File Cache resource.
The system-generated, unique ID of the cache.
" } + }, + "ReleaseConfiguration": { + "target": "com.amazonaws.fsx#ReleaseConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies the last accessed time criteria for files\n that will be released from an Amazon FSx for Lustre file system.
" + } } }, "traits": { - "smithy.api#documentation": "A description of the data repository task. You use data repository tasks\n to perform bulk transfer operations between an Amazon FSx for Lustre file system\n and a linked data repository. An Amazon File Cache resource uses a task to\n automatically release files from the cache.
" + "smithy.api#documentation": "A description of the data repository task.
\nYou use import and export data repository tasks to perform\n bulk transfer operations between an Amazon FSx for Lustre file system\n and a linked data repository.
\nYou use release data repository tasks to release archived files\n from your Amazon FSx for Lustre file system.
\nAn Amazon File Cache resource uses a task to automatically\n release files from the cache.
\nTo learn more about data repository tasks, see \n Data Repository Tasks. \n
" } }, "com.amazonaws.fsx#DataRepositoryTaskEnded": { @@ -4503,6 +4561,19 @@ ], "traits": { "smithy.api#documentation": "Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and\n its data is gone.
\nThe DeleteBackup
call returns instantly. The backup won't show up in\n later DescribeBackups
calls.
The data in a deleted backup is also deleted and can't be recovered by any\n means.
\nDeletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.
\nTo delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId
value to the DeleFileSystem
operation.
By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.
\nThe DeleteFileSystem
operation returns while the file system has the\n DELETING
status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems
operation returns a FileSystemNotFound
\n error.
If a data repository task is in a PENDING
or EXECUTING
state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by\n any means.
\nSetting this to true
allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume \n with unexpired write once, read many (WORM) files. The IAM permission fsx:BypassSnaplockEnterpriseRetention
is also \n required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is false
.
For more information, see \n \n Deleting a SnapLock volume\n .
" + "smithy.api#documentation": "Setting this to true
allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume \n with unexpired write once, read many (WORM) files. The IAM permission fsx:BypassSnaplockEnterpriseRetention
is also \n required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is false
.
For more information, see \n \n Deleting a SnapLock volume.
" } } }, @@ -6037,7 +6121,7 @@ } }, "traits": { - "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx \n automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per\n GB of storage. The configuration consists of the total number of provisioned SSD IOPS\n and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
" + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx \n automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per\n GB of storage. The configuration consists of the total number of provisioned SSD IOPS\n and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
" } }, "com.amazonaws.fsx#DiskIopsConfigurationMode": { @@ -6086,6 +6170,26 @@ } } }, + "com.amazonaws.fsx#DurationSinceLastAccess": { + "type": "structure", + "members": { + "Unit": { + "target": "com.amazonaws.fsx#Unit", + "traits": { + "smithy.api#documentation": "The unit of time used by the Value
parameter to\n determine if a file can be released, based on when it was last\n accessed. DAYS
is the only supported value. This\n is a required parameter.
An integer that represents the minimum amount of time (in days)\n since a file was last accessed in the file system. Only archived files\n with a MAX(atime, ctime, mtime)
timestamp that is more than\n this amount of time in the past (relative to the task create time)\n will be released. The default of Value
is 0
.\n This is a required parameter.
If an archived file meets the last accessed time criteria,\n its file or directory path must also be specified in the Paths
\n parameter of the operation\n in order for the file to be released.
Defines the minimum amount of time since last access for a \n file to be eligible for release. Only archived files that were\n last accessed or modified before this point-in-time are eligible\n to be released from the Amazon FSx for Lustre file system.
" + } + }, "com.amazonaws.fsx#EndTime": { "type": "timestamp" }, @@ -7356,6 +7460,23 @@ ], "traits": { "smithy.api#documentation": "Lists tags for Amazon FSx resources.
\nWhen retrieving all tags, you can optionally specify the MaxResults
\n parameter to limit the number of tags in a response. If more tags remain, Amazon FSx\n returns a NextToken
value in the response. In this case, send a later\n request with the NextToken
request parameter set to the value of\n NextToken
from the last response.
This action is used in an iterative process to retrieve a list of your tags.\n ListTagsForResource
is called first without a\n NextToken
value. Then the action continues to be called with the\n NextToken
parameter set to the value of the last NextToken
\n value until a response has no NextToken
.
When using this action, keep the following in mind:
\nThe implementation might return fewer than MaxResults
file\n system descriptions while still including a NextToken
\n value.
The order of tags returned in the response of one\n ListTagsForResource
call and the order of tags returned across\n the responses of a multi-call iteration is unspecified.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\u2028 SINGLE_AZ_1
and SINGLE_AZ_2
.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\u2028 MULTI_AZ_1
, SINGLE_AZ_1
, and SINGLE_AZ_2
.
The ID of the root volume of the OpenZFS file system.
" } + }, + "PreferredSubnetId": { + "target": "com.amazonaws.fsx#SubnetId", + "traits": { + "smithy.api#documentation": "Required when DeploymentType
is set to MULTI_AZ_1
. This\n specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\n selects an available /28 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.
" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.fsx#RouteTableIds", + "traits": { + "smithy.api#documentation": "(Multi-AZ only) The VPC route tables in which your file system's endpoints are\n created.
" + } + }, + "EndpointIpAddress": { + "target": "com.amazonaws.fsx#IpAddress", + "traits": { + "smithy.api#documentation": "The IP address of the endpoint\n that is used to access data or to manage the file system.
" + } } }, "traits": { @@ -8513,6 +8664,20 @@ "smithy.api#pattern": "^[a-z0-9-]{1,20}$" } }, + "com.amazonaws.fsx#ReleaseConfiguration": { + "type": "structure", + "members": { + "DurationSinceLastAccess": { + "target": "com.amazonaws.fsx#DurationSinceLastAccess", + "traits": { + "smithy.api#documentation": "Defines the point-in-time since an archived file was last accessed,\n in order for that file to be eligible for release. Only files that were\n last accessed before this point-in-time are eligible to be released from\n the file system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that specifies a minimum amount of time since\n last access for an archived file to be eligible for release from an\n Amazon FSx for Lustre file system. Only files that were last\n accessed before this point-in-time can be released. For example, if\n you specify a last accessed time criteria of 9 days, only files that\n were last accessed 9.00001 or more days ago can be released.
\nOnly file data that has been archived can be released. Files that\n have not yet been archived, such as new or changed files that have\n not been exported, are not eligible for release. When files are\n released, their metadata stays on the file system, so they\n can still be accessed later. Users and applications can access a\n released file by reading the file again, which restores data from\n Amazon S3 to the FSx for Lustre file system.
\nIf a file meets the last accessed time criteria, its\n file or directory path must also be specified with the\n Paths
parameter of the\n operation in order\n for the file to be released.
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read \n many (WORM) files even \n if they have active retention periods. PERMANENTLY_DISABLED
is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED
.
For more information, see Privileged delete.
" + "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read \n many (WORM) files even \n if they have active retention periods. PERMANENTLY_DISABLED
is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED
.
For more information, see Privileged delete.
" } }, "RetentionPeriod": { @@ -9212,7 +9377,7 @@ "SnaplockType": { "target": "com.amazonaws.fsx#SnaplockType", "traits": { - "smithy.api#documentation": "Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. \n You can choose one of the following retention modes:
\n\n COMPLIANCE
: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted \n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect \n against ransomware attacks. For more information, \n see SnapLock Compliance.
\n ENTERPRISE
: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users \n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity \n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see \n SnapLock Enterprise.
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. \n You can choose one of the following retention modes:
\n\n COMPLIANCE
: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted \n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect \n against ransomware attacks. For more information, \n see SnapLock Compliance.
\n ENTERPRISE
: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users \n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity \n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see \n SnapLock Enterprise.
Tags an Amazon FSx resource.
", + "smithy.api#examples": [ + { + "title": "To tag a resource", + "documentation": "This operation tags an Amazon FSx resource.", + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + } + } + ], "smithy.api#idempotent": {} } }, @@ -10188,6 +10368,17 @@ "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,36}$" } }, + "com.amazonaws.fsx#Unit": { + "type": "enum", + "members": { + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAYS" + } + } + } + }, "com.amazonaws.fsx#UnsupportedOperation": { "type": "structure", "members": { @@ -10227,6 +10418,16 @@ ], "traits": { "smithy.api#documentation": "This action removes a tag from an Amazon FSx resource.
", + "smithy.api#examples": [ + { + "title": "To untag a resource", + "documentation": "This operation untags an Amazon FSx resource.", + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "TagKeys": ["Name"] + } + } + ], "smithy.api#idempotent": {} } }, @@ -10461,7 +10662,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n SelfManagedActiveDirectoryConfiguration
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DataCompressionType
\n
\n LogConfiguration
\n
\n LustreRootSquashConfiguration
\n
\n StorageCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n FsxAdminPassword
\n
\n RemoveRouteTableIds
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays
\n
\n CopyTagsToBackups
\n
\n CopyTagsToVolumes
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n SelfManagedActiveDirectoryConfiguration
\n
\n StorageCapacity
\n
\n StorageType
\n
\n ThroughputCapacity
\n
\n DiskIopsConfiguration
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DataCompressionType
\n
\n LogConfiguration
\n
\n LustreRootSquashConfiguration
\n
\n StorageCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n FsxAdminPassword
\n
\n RemoveRouteTableIds
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays
\n
\n CopyTagsToBackups
\n
\n CopyTagsToVolumes
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables\n to associate (add) with your Amazon FSx for OpenZFS file system.
" + } + }, + "RemoveRouteTableIds": { + "target": "com.amazonaws.fsx#RouteTableIds", + "traits": { + "smithy.api#documentation": "(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC)\n route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use\n the API operation to retrieve the\n list of VPC route table IDs for a file system.
" + } } }, "traits": { @@ -10636,6 +10849,9 @@ "traits": { "smithy.api#documentation": "The configuration updates for an FSx for OpenZFS file system.
" } + }, + "StorageType": { + "target": "com.amazonaws.fsx#StorageType" } }, "traits": { @@ -10696,6 +10912,12 @@ "traits": { "smithy.api#documentation": "The configuration that Amazon FSx for Windows File Server uses to audit and log\n user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server\n file system..
" } + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration", + "traits": { + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.\n By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional\n IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" + } } }, "traits": { @@ -10826,7 +11048,7 @@ "PrivilegedDelete": { "target": "com.amazonaws.fsx#PrivilegedDelete", "traits": { - "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read \n many (WORM) files even \n if they have active retention periods. PERMANENTLY_DISABLED
is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED
.
For more information, see \n Privileged delete.
" + "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read \n many (WORM) files even \n if they have active retention periods. PERMANENTLY_DISABLED
is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED
.
For more information, see \n Privileged delete.
" } }, "RetentionPeriod": { @@ -11084,6 +11306,14 @@ "smithy.api#output": {} } }, + "com.amazonaws.fsx#Value": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.fsx#Volume": { "type": "structure", "members": { @@ -11430,7 +11660,7 @@ "AuditLogDestination": { "target": "com.amazonaws.fsx#GeneralARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the destination of the audit logs.\n The destination can be any Amazon CloudWatch Logs log group ARN or\n Amazon Kinesis Data Firehose delivery stream ARN.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx
prefix. The name of the Amazon Kinesis Data\n Firehouse delivery stream must begin with the aws-fsx
prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis\n Data Firehose delivery stream) must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the destination of the audit logs.\n The destination can be any Amazon CloudWatch Logs log group ARN or\n Amazon Kinesis Data Firehose delivery stream ARN.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx
prefix. The name of the Amazon Kinesis Data\n Firehose delivery stream must begin with the aws-fsx
prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis\n Data Firehose delivery stream) must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
" } } }, @@ -11458,7 +11688,7 @@ "AuditLogDestination": { "target": "com.amazonaws.fsx#GeneralARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
\nThe destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis\n Data Firehose delivery stream ARN, with the following requirements:
\nThe destination ARN that you provide (either CloudWatch Logs log group\n or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx
prefix. The name of the Amazon Kinesis Data\n Firehouse delivery stream must begin with the aws-fsx
prefix.
If you do not provide a destination in AuditLogDestination
,\n Amazon FSx will create and use a log stream in the CloudWatch Logs\n /aws/fsx/windows
log group.
If AuditLogDestination
is provided and the resource does not\n exist, the request will fail with a BadRequest
error.
If FileAccessAuditLogLevel
and FileShareAccessAuditLogLevel
\n are both set to DISABLED
, you cannot specify a destination in\n AuditLogDestination
.
The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
\nThe destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis\n Data Firehose delivery stream ARN, with the following requirements:
\nThe destination ARN that you provide (either CloudWatch Logs log group\n or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx
prefix. The name of the Amazon Kinesis Data\n Firehose delivery stream must begin with the aws-fsx
prefix.
If you do not provide a destination in AuditLogDestination
,\n Amazon FSx will create and use a log stream in the CloudWatch Logs\n /aws/fsx/windows
log group.
If AuditLogDestination
is provided and the resource does not\n exist, the request will fail with a BadRequest
error.
If FileAccessAuditLogLevel
and FileShareAccessAuditLogLevel
\n are both set to DISABLED
, you cannot specify a destination in\n AuditLogDestination
.
The configuration that Amazon FSx for Windows File Server uses to audit and log\n user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server\n file system.
" } + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration", + "traits": { + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.\n By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional\n IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" + } } }, "traits": {