FSx *** Client ====== class FSx.Client A low-level client representing Amazon FSx Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage. import boto3 client = boto3.client('fsx') These are the available methods: * associate_file_system_aliases * can_paginate * cancel_data_repository_task * close * copy_backup * copy_snapshot_and_update_volume * create_and_attach_s3_access_point * create_backup * create_data_repository_association * create_data_repository_task * create_file_cache * create_file_system * create_file_system_from_backup * create_snapshot * create_storage_virtual_machine * create_volume * create_volume_from_backup * delete_backup * delete_data_repository_association * delete_file_cache * delete_file_system * delete_snapshot * delete_storage_virtual_machine * delete_volume * describe_backups * describe_data_repository_associations * describe_data_repository_tasks * describe_file_caches * describe_file_system_aliases * describe_file_systems * describe_s3_access_point_attachments * describe_shared_vpc_configuration * describe_snapshots * describe_storage_virtual_machines * describe_volumes * detach_and_delete_s3_access_point * disassociate_file_system_aliases * get_paginator * get_waiter * list_tags_for_resource * release_file_system_nfs_v3_locks * restore_volume_from_snapshot * start_misconfigured_state_recovery * tag_resource * untag_resource * update_data_repository_association * update_file_cache * update_file_system * update_shared_vpc_configuration * update_snapshot * update_storage_virtual_machine * update_volume Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeBackups * DescribeFileSystems * DescribeS3AccessPointAttachments * DescribeSnapshots * DescribeStorageVirtualMachines * DescribeVolumes * ListTagsForResource FSx / Paginator / ListTagsForResource ListTagsForResource ******************* class FSx.Paginator.ListTagsForResource paginator = client.get_paginator('list_tags_for_resource') paginate(**kwargs) Creates an iterator that will paginate through responses from "FSx.Client.list_tags_for_resource()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ResourceARN='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the Amazon FSx resource that will have its tags listed. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], } **Response Structure** * *(dict) --* The response object for "ListTagsForResource" operation. * **Tags** *(list) --* A list of tags on the resource. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". FSx / Paginator / DescribeVolumes DescribeVolumes *************** class FSx.Paginator.DescribeVolumes paginator = client.get_paginator('describe_volumes') paginate(**kwargs) Creates an iterator that will paginate through responses from "FSx.Client.describe_volumes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( VolumeIds=[ 'string', ], Filters=[ { 'Name': 'file-system-id'|'storage-virtual-machine-id', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **VolumeIds** (*list*) -- The IDs of the volumes whose descriptions you want to retrieve. * *(string) --* * **Filters** (*list*) -- Enter a filter "Name" and "Values" pair to view a select set of volumes. * *(dict) --* A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use multiple filters to return results that meet all applied filter requirements. * **Name** *(string) --* The name for this filter. * **Values** *(list) --* The values of the filter. These are all the values for any of the applied filters. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Volumes': [ { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': {'... recursive ...'}, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, ], } **Response Structure** * *(dict) --* * **Volumes** *(list) --* Returned after a successful "DescribeVolumes" operation, describing each volume. * *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data- protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high- availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file- system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore-volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update- snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy-snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage- capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage- optimization process. * "PENDING" - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently- tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single- AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration ** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self-managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi-AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3 ://import-bucket/optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in-transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero- padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero- padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second- generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero- padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read-only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. FSx / Paginator / DescribeStorageVirtualMachines DescribeStorageVirtualMachines ****************************** class FSx.Paginator.DescribeStorageVirtualMachines paginator = client.get_paginator('describe_storage_virtual_machines') paginate(**kwargs) Creates an iterator that will paginate through responses from "FSx.Client.describe_storage_virtual_machines()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( StorageVirtualMachineIds=[ 'string', ], Filters=[ { 'Name': 'file-system-id', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **StorageVirtualMachineIds** (*list*) -- Enter the ID of one or more SVMs that you want to view. * *(string) --* * **Filters** (*list*) -- Enter a filter name:value pair to view a select set of SVMs. * *(dict) --* A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). You can use multiple filters to return results that meet all applied filter requirements. * **Name** *(string) --* The name for this filter. * **Values** *(list) --* The values of the filter. These are all the values for any of the applied filters. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'StorageVirtualMachines': [ { 'ActiveDirectoryConfiguration': { 'NetBiosName': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] } }, 'CreationTime': datetime(2015, 1, 1), 'Endpoints': { 'Iscsi': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Nfs': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Smb': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'FileSystemId': 'string', 'Lifecycle': 'CREATED'|'CREATING'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING', 'Name': 'string', 'ResourceARN': 'string', 'StorageVirtualMachineId': 'string', 'Subtype': 'DEFAULT'|'DP_DESTINATION'|'SYNC_DESTINATION'|'SYNC_SOURCE', 'UUID': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'LifecycleTransitionReason': { 'Message': 'string' }, 'RootVolumeSecurityStyle': 'UNIX'|'NTFS'|'MIXED' }, ], } **Response Structure** * *(dict) --* * **StorageVirtualMachines** *(list) --* Returned after a successful "DescribeStorageVirtualMachines" operation, describing each SVM. * *(dict) --* Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration. * **ActiveDirectoryConfiguration** *(dict) --* Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable. * **NetBiosName** *(string) --* The NetBIOS name of the AD computer object to which the SVM is joined. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Endpoints** *(dict) --* The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the "Iscsi", "Management", "Nfs", and "Smb" endpoints. * **Iscsi** *(dict) --* An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Management** *(dict) --* An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Nfs** *(dict) --* An endpoint for connecting using the Network File System (NFS) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Smb** *(dict) --* An endpoint for connecting using the Server Message Block (SMB) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* Describes the SVM's lifecycle status. * "CREATED" - The SVM is fully available for use. * "CREATING" - Amazon FSx is creating the new SVM. * "DELETING" - Amazon FSx is deleting an existing SVM. * "FAILED" - Amazon FSx was unable to create the SVM. * "MISCONFIGURED" - The SVM is in a failed but recoverable state. * "PENDING" - Amazon FSx has not started creating the SVM. * **Name** *(string) --* The name of the SVM, if provisioned. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **StorageVirtualMachineId** *(string) --* The SVM's system generated unique ID. * **Subtype** *(string) --* Describes the SVM's subtype. * **UUID** *(string) --* The SVM's UUID (universally unique identifier). * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **LifecycleTransitionReason** *(dict) --* Describes why the SVM lifecycle state changed. * **Message** *(string) --* A detailed error message. * **RootVolumeSecurityStyle** *(string) --* The security style of the root volume of the SVM. FSx / Paginator / DescribeBackups DescribeBackups *************** class FSx.Paginator.DescribeBackups paginator = client.get_paginator('describe_backups') paginate(**kwargs) Creates an iterator that will paginate through responses from "FSx.Client.describe_backups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BackupIds=[ 'string', ], Filters=[ { 'Name': 'file-system-id'|'backup-type'|'file-system-type'|'volume-id'|'data-repository-type'|'file-cache-id'|'file-cache-type', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BackupIds** (*list*) -- The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a "BackupNotFound" error occurs. * *(string) --* The ID of the source backup. Specifies the backup that you are copying. * **Filters** (*list*) -- The filters structure. The supported names are "file- system-id", "backup-type", "file-system-type", and "volume- id". * *(dict) --* A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements. * **Name** *(string) --* The name for this filter. * **Values** *(list) --* The values of the filter. These are all the values for any of the applied filters. * *(string) --* The value for a filter. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Backups': [ { 'BackupId': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING'|'COPYING', 'FailureDetails': { 'Message': 'string' }, 'Type': 'AUTOMATIC'|'USER_INITIATED'|'AWS_BACKUP', 'ProgressPercent': 123, 'CreationTime': datetime(2015, 1, 1), 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FileSystem': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': {'... recursive ...'}, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'DirectoryInformation': { 'DomainName': 'string', 'ActiveDirectoryId': 'string', 'ResourceARN': 'string' }, 'OwnerId': 'string', 'SourceBackupId': 'string', 'SourceBackupRegion': 'string', 'ResourceType': 'FILE_SYSTEM'|'VOLUME', 'Volume': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': {'... recursive ...'}, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'SizeInBytes': 123 }, ], } **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation FSx / Paginator / DescribeS3AccessPointAttachments DescribeS3AccessPointAttachments ******************************** class FSx.Paginator.DescribeS3AccessPointAttachments paginator = client.get_paginator('describe_s3_access_point_attachments') paginate(**kwargs) Creates an iterator that will paginate through responses from "FSx.Client.describe_s3_access_point_attachments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Names=[ 'string', ], Filters=[ { 'Name': 'file-system-id'|'volume-id'|'type', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Names** (*list*) -- The names of the S3 access point attachments whose descriptions you want to retrieve. * *(string) --* * **Filters** (*list*) -- Enter a filter Name and Values pair to view a select set of S3 access point attachments. * *(dict) --* A set of Name and Values pairs used to view a select set of S3 access point attachments. * **Name** *(string) --* The name of the filter. * **Values** *(list) --* The values of the filter. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'S3AccessPointAttachments': [ { 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'UPDATING'|'FAILED', 'LifecycleTransitionReason': { 'Message': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'Name': 'string', 'Type': 'OPENZFS', 'OpenZFSConfiguration': { 'VolumeId': 'string', 'FileSystemIdentity': { 'Type': 'POSIX', 'PosixUser': { 'Uid': 123, 'Gid': 123, 'SecondaryGids': [ 123, ] } } }, 'S3AccessPoint': { 'ResourceARN': 'string', 'Alias': 'string', 'VpcConfiguration': { 'VpcId': 'string' } } }, ], } **Response Structure** * *(dict) --* * **S3AccessPointAttachments** *(list) --* Array of S3 access point attachments returned after a successful "DescribeS3AccessPointAttachments" operation. * *(dict) --* An S3 access point attached to an Amazon FSx volume. * **Lifecycle** *(string) --* The lifecycle status of the S3 access point attachment. The lifecycle can have the following values: * AVAILABLE - the S3 access point attachment is available for use * CREATING - Amazon FSx is creating the S3 access point and attachment * DELETING - Amazon FSx is deleting the S3 access point and attachment * FAILED - The S3 access point attachment is in a failed state. Delete and detach the S3 access point attachment, and create a new one. * UPDATING - Amazon FSx is updating the S3 access point attachment * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Name** *(string) --* The name of the S3 access point attachment; also used for the name of the S3 access point. * **Type** *(string) --* The type of Amazon FSx volume that the S3 access point is attached to. * **OpenZFSConfiguration** *(dict) --* The OpenZFSConfiguration of the S3 access point attachment. * **VolumeId** *(string) --* The ID of the FSx for OpenZFS volume that the S3 access point is attached to. * **FileSystemIdentity** *(dict) --* The file system identity used to authorize file access requests made using the S3 access point. * **Type** *(string) --* Specifies the FSx for OpenZFS user identity type, accepts only "POSIX". * **PosixUser** *(dict) --* Specifies the UID and GIDs of the file system POSIX user. * **Uid** *(integer) --* The UID of the file system user. * **Gid** *(integer) --* The GID of the file system user. * **SecondaryGids** *(list) --* The list of secondary GIDs for the file system user. * *(integer) --* * **S3AccessPoint** *(dict) --* The S3 access point configuration of the S3 access point attachment. * **ResourceARN** *(string) --* he S3 access point's ARN. * **Alias** *(string) --* The S3 access point's alias. * **VpcConfiguration** *(dict) --* The S3 access point's virtual private cloud (VPC) configuration. * **VpcId** *(string) --* Specifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists. FSx / Paginator / DescribeSnapshots DescribeSnapshots ***************** class FSx.Paginator.DescribeSnapshots paginator = client.get_paginator('describe_snapshots') paginate(**kwargs) Creates an iterator that will paginate through responses from "FSx.Client.describe_snapshots()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SnapshotIds=[ 'string', ], Filters=[ { 'Name': 'file-system-id'|'volume-id', 'Values': [ 'string', ] }, ], IncludeShared=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **SnapshotIds** (*list*) -- The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a "SnapshotNotFound" error occurs. * *(string) --* * **Filters** (*list*) -- The filters structure. The supported names are "file- system-id" or "volume-id". * *(dict) --* A filter used to restrict the results of "DescribeSnapshots" calls. You can use multiple filters to return results that meet all applied filter requirements. * **Name** *(string) --* The name of the filter to use. You can filter by the "file-system-id" or by "volume-id". * **Values** *(list) --* The "file-system-id" or "volume-id" that you are filtering for. * *(string) --* * **IncludeShared** (*boolean*) -- Set to "false" (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to "true" if you want to see the snapshots in your account and the ones shared with you from another account. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Snapshots': [ { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': {'... recursive ...'}, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ] }, ], } **Response Structure** * *(dict) --* * **Snapshots** *(list) --* An array of snapshots. * *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file- system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore-volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update- snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy-snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage- capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage- optimization process. * "PENDING" - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently- tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single- AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration ** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self-managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi-AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3 ://import-bucket/optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in-transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero- padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero- padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second- generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero- padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load- sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry- specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read- only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. FSx / Paginator / DescribeFileSystems DescribeFileSystems ******************* class FSx.Paginator.DescribeFileSystems paginator = client.get_paginator('describe_file_systems') paginate(**kwargs) Creates an iterator that will paginate through responses from "FSx.Client.describe_file_systems()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( FileSystemIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **FileSystemIds** (*list*) -- IDs of the file systems whose descriptions you want to retrieve (String). * *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'FileSystems': [ { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': {'... recursive ...'}, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, ], } **Response Structure** * *(dict) --* The response object for "DescribeFileSystems" operation. * **FileSystems** *(list) --* An array of file system descriptions. * *(dict) --* A description of a specific Amazon FSx file system. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi-AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket /optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in-transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent- Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file- system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore-volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update- snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy-snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage- capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage- optimization process. * "PENDING" - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network- attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data- protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read-only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second- generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user- initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). FSx / Client / create_snapshot create_snapshot *************** FSx.Client.create_snapshot(**kwargs) Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version. If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns "IncompatibleParameterError". If a snapshot with the specified client request token doesn't exist, "CreateSnapshot" does the following: * Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of "CREATING". * Returns the description of the snapshot. By using the idempotent operation, you can retry a "CreateSnapshot" operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same. The "CreateSnapshot" operation returns while the snapshot's lifecycle state is still "CREATING". You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information. See also: AWS API Documentation **Request Syntax** response = client.create_snapshot( ClientRequestToken='string', Name='string', VolumeId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) type ClientRequestToken: string param ClientRequestToken: (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type Name: string param Name: **[REQUIRED]** The name of the snapshot. type VolumeId: string param VolumeId: **[REQUIRED]** The ID of the volume that you are taking a snapshot of. type Tags: list param Tags: A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". rtype: dict returns: **Response Syntax** { 'Snapshot': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': {'... recursive ...'}, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ] } } **Response Structure** * *(dict) --* * **Snapshot** *(dict) --* A description of the snapshot. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi- AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket /optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in- transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent- Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi- AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load- sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read- only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.VolumeNotFound" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.InternalServerError" FSx / Client / start_misconfigured_state_recovery start_misconfigured_state_recovery ********************************** FSx.Client.start_misconfigured_state_recovery(**kwargs) After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system. See also: AWS API Documentation **Request Syntax** response = client.start_misconfigured_state_recovery( ClientRequestToken='string', FileSystemId='string' ) type ClientRequestToken: string param ClientRequestToken: (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type FileSystemId: string param FileSystemId: **[REQUIRED]** The globally unique ID of the file system, assigned by Amazon FSx. rtype: dict returns: **Response Syntax** { 'FileSystem': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': {'... recursive ...'}, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } } } **Response Structure** * *(dict) --* * **FileSystem** *(dict) --* A description of a specific Amazon FSx file system. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self-managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self- managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi-AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket/optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in-transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re- mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data- protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read-only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second- generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.InternalServerError" FSx / Client / get_paginator get_paginator ************* FSx.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. FSx / Client / describe_snapshots describe_snapshots ****************** FSx.Client.describe_snapshots(**kwargs) Returns the description of specific Amazon FSx for OpenZFS snapshots, if a "SnapshotIds" value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all snapshots, you can optionally specify the "MaxResults" parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a "NextToken" value in the response. In this case, send a later request with the "NextToken" request parameter set to the value of "NextToken" from the last response. Use this operation in an iterative process to retrieve a list of your snapshots. "DescribeSnapshots" is called first without a "NextToken" value. Then the operation continues to be called with the "NextToken" parameter set to the value of the last "NextToken" value until a response has no "NextToken" value. When using this operation, keep the following in mind: * The operation might return fewer than the "MaxResults" value of snapshot descriptions while still including a "NextToken" value. * The order of snapshots returned in the response of one "DescribeSnapshots" call and the order of backups returned across the responses of a multi-call iteration is unspecified. See also: AWS API Documentation **Request Syntax** response = client.describe_snapshots( SnapshotIds=[ 'string', ], Filters=[ { 'Name': 'file-system-id'|'volume-id', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', IncludeShared=True|False ) type SnapshotIds: list param SnapshotIds: The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a "SnapshotNotFound" error occurs. * *(string) --* type Filters: list param Filters: The filters structure. The supported names are "file-system- id" or "volume-id". * *(dict) --* A filter used to restrict the results of "DescribeSnapshots" calls. You can use multiple filters to return results that meet all applied filter requirements. * **Name** *(string) --* The name of the filter to use. You can filter by the "file-system-id" or by "volume-id". * **Values** *(list) --* The "file-system-id" or "volume-id" that you are filtering for. * *(string) --* type MaxResults: integer param MaxResults: The maximum number of resources to return in the response. This value must be an integer greater than zero. type NextToken: string param NextToken: (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous "NextToken" value left off. type IncludeShared: boolean param IncludeShared: Set to "false" (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to "true" if you want to see the snapshots in your account and the ones shared with you from another account. rtype: dict returns: **Response Syntax** { 'Snapshots': [ { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': {'... recursive ...'}, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Snapshots** *(list) --* An array of snapshots. * *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently- tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self-managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self- managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi-AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import- bucket/optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter- term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in- transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user- initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first- generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user- initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read-only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. * **NextToken** *(string) --* (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous "NextToken" value left off. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.SnapshotNotFound" FSx / Client / can_paginate can_paginate ************ FSx.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. FSx / Client / describe_file_system_aliases describe_file_system_aliases **************************** FSx.Client.describe_file_system_aliases(**kwargs) Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response. See also: AWS API Documentation **Request Syntax** response = client.describe_file_system_aliases( ClientRequestToken='string', FileSystemId='string', MaxResults=123, NextToken='string' ) Parameters: * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **FileSystemId** (*string*) -- **[REQUIRED]** The ID of the file system to return the associated DNS aliases for (String). * **MaxResults** (*integer*) -- Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the "MaxResults" parameter specified in the request and the service's internal maximum number of items per page. * **NextToken** (*string*) -- Opaque pagination token returned from a previous "DescribeFileSystemAliases" operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off. Return type: dict Returns: **Response Syntax** { 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response object for "DescribeFileSystemAliases" operation. * **Aliases** *(list) --* An array of one or more DNS aliases currently associated with the specified file system. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user- defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **NextToken** *(string) --* Present if there are more DNS aliases than returned in the response (String). You can use the "NextToken" value in a later request to fetch additional descriptions. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.InternalServerError" FSx / Client / delete_backup delete_backup ************* FSx.Client.delete_backup(**kwargs) Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone. The "DeleteBackup" call returns instantly. The backup won't show up in later "DescribeBackups" calls. Warning: The data in a deleted backup is also deleted and can't be recovered by any means. See also: AWS API Documentation **Request Syntax** response = client.delete_backup( BackupId='string', ClientRequestToken='string' ) Parameters: * **BackupId** (*string*) -- **[REQUIRED]** The ID of the backup that you want to delete. * **ClientRequestToken** (*string*) -- A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'BackupId': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING'|'COPYING' } **Response Structure** * *(dict) --* The response object for the "DeleteBackup" operation. * **BackupId** *(string) --* The ID of the backup that was deleted. * **Lifecycle** *(string) --* The lifecycle status of the backup. If the "DeleteBackup" operation is successful, the status is "DELETED". **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.BackupInProgress" * "FSx.Client.exceptions.BackupNotFound" * "FSx.Client.exceptions.BackupRestoring" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.BackupBeingCopied" **Examples** This operation deletes an Amazon FSx file system backup. response = client.delete_backup( BackupId='backup-03e3c82e0183b7b6b', ) print(response) Expected Output: { 'BackupId': 'backup-03e3c82e0183b7b6b', 'Lifecycle': 'DELETED', 'ResponseMetadata': { '...': '...', }, } FSx / Client / create_backup create_backup ************* FSx.Client.create_backup(**kwargs) Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume. For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration: * A Persistent deployment type * Are *not* linked to a data repository For more information about backups, see the following: * For Amazon FSx for Lustre, see Working with FSx for Lustre backups. * For Amazon FSx for Windows, see Working with FSx for Windows backups. * For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups. * For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups. If a backup with the specified client request token exists and the parameters match, this operation returns the description of the existing backup. If a backup with the specified client request token exists and the parameters don't match, this operation returns "IncompatibleParameterError". If a backup with the specified client request token doesn't exist, "CreateBackup" does the following: * Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of "CREATING". * Returns the description of the backup. By using the idempotent operation, you can retry a "CreateBackup" operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same. The "CreateBackup" operation returns while the backup's lifecycle state is still "CREATING". You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information. See also: AWS API Documentation **Request Syntax** response = client.create_backup( FileSystemId='string', ClientRequestToken='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], VolumeId='string' ) Parameters: * **FileSystemId** (*string*) -- The ID of the file system to back up. * **ClientRequestToken** (*string*) -- (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **Tags** (*list*) -- (Optional) The tags to apply to the backup at backup creation. The key value of the "Name" tag appears in the console as the backup name. If you have set "CopyTagsToBackups" to "true", and you specify one or more tags using the "CreateBackup" operation, no existing file system tags are copied from the file system to the backup. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** (*string*) -- (Optional) The ID of the FSx for ONTAP volume to back up. Return type: dict Returns: **Response Syntax** { 'Backup': { 'BackupId': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING'|'COPYING', 'FailureDetails': { 'Message': 'string' }, 'Type': 'AUTOMATIC'|'USER_INITIATED'|'AWS_BACKUP', 'ProgressPercent': 123, 'CreationTime': datetime(2015, 1, 1), 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FileSystem': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': {'... recursive ...'}, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'DirectoryInformation': { 'DomainName': 'string', 'ActiveDirectoryId': 'string', 'ResourceARN': 'string' }, 'OwnerId': 'string', 'SourceBackupId': 'string', 'SourceBackupRegion': 'string', 'ResourceType': 'FILE_SYSTEM'|'VOLUME', 'Volume': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': {'... recursive ...'}, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'SizeInBytes': 123 } } **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.UnsupportedOperation" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.VolumeNotFound" * "FSx.Client.exceptions.BackupInProgress" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.InternalServerError" **Examples** This operation creates a new backup. response = client.create_backup( FileSystemId='fs-0498eed5fe91001ec', Tags=[ { 'Key': 'Name', 'Value': 'MyBackup', }, ], ) print(response) Expected Output: { 'Backup': { 'BackupId': 'backup-03e3c82e0183b7b6b', 'CreationTime': datetime(2016, 12, 15, 17, 38, 44, 3, 350, 0), 'FileSystem': { 'FileSystemId': 'fs-0498eed5fe91001ec', 'OwnerId': '012345678912', 'StorageCapacity': 300, 'WindowsConfiguration': { 'ActiveDirectoryId': 'd-1234abcd12', 'AutomaticBackupRetentionDays': 30, 'DailyAutomaticBackupStartTime': '05:00', 'WeeklyMaintenanceStartTime': '1:05:00', }, }, 'Lifecycle': 'CREATING', 'ProgressPercent': 0, 'ResourceARN': 'arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b', 'Tags': [ { 'Key': 'Name', 'Value': 'MyBackup', }, ], 'Type': 'USER_INITIATED', }, 'ResponseMetadata': { '...': '...', }, } FSx / Client / update_snapshot update_snapshot *************** FSx.Client.update_snapshot(**kwargs) Updates the name of an Amazon FSx for OpenZFS snapshot. See also: AWS API Documentation **Request Syntax** response = client.update_snapshot( ClientRequestToken='string', Name='string', SnapshotId='string' ) type ClientRequestToken: string param ClientRequestToken: (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type Name: string param Name: **[REQUIRED]** The name of the snapshot to update. type SnapshotId: string param SnapshotId: **[REQUIRED]** The ID of the snapshot that you want to update, in the format "fsvolsnap-0123456789abcdef0". rtype: dict returns: **Response Syntax** { 'Snapshot': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': {'... recursive ...'}, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ] } } **Response Structure** * *(dict) --* * **Snapshot** *(dict) --* Returned after a successful "UpdateSnapshot" operation, describing the snapshot that you updated. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi- AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket /optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in- transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent- Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi- AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load- sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read- only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.SnapshotNotFound" * "FSx.Client.exceptions.InternalServerError" FSx / Client / update_storage_virtual_machine update_storage_virtual_machine ****************************** FSx.Client.update_storage_virtual_machine(**kwargs) Updates an FSx for ONTAP storage virtual machine (SVM). See also: AWS API Documentation **Request Syntax** response = client.update_storage_virtual_machine( ActiveDirectoryConfiguration={ 'SelfManagedActiveDirectoryConfiguration': { 'UserName': 'string', 'Password': 'string', 'DnsIps': [ 'string', ], 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string' }, 'NetBiosName': 'string' }, ClientRequestToken='string', StorageVirtualMachineId='string', SvmAdminPassword='string' ) Parameters: * **ActiveDirectoryConfiguration** (*dict*) -- Specifies updates to an SVM's Microsoft Active Directory (AD) configuration. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* Specifies changes you are making to the self-managed Microsoft Active Directory configuration to which an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined. * **UserName** *(string) --* Specifies the updated user name for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. This account must have the permissions required to join computers to the domain in the organizational unit provided in "OrganizationalUnitDistinguishedName". * **Password** *(string) --* Specifies the updated password for the service account on your self-managed Active Directory domain. Amazon FSx uses this account to join to your self-managed Active Directory domain. * **DnsIps** *(list) --* A list of up to three DNS server or domain controller IP addresses in your self-managed Active Directory domain. * *(string) --* * **DomainName** *(string) --* Specifies an updated fully qualified domain name of your self-managed Active Directory configuration. * **OrganizationalUnitDistinguishedName** *(string) --* Specifies an updated fully qualified distinguished name of the organization unit within your self-managed Active Directory. * **FileSystemAdministratorsGroup** *(string) --* For FSx for ONTAP file systems only - Specifies the updated name of the self-managed Active Directory domain group whose members are granted administrative privileges for the Amazon FSx resource. * **NetBiosName** *(string) --* Specifies an updated NetBIOS name of the AD computer object "NetBiosName" to which an SVM is joined. * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **StorageVirtualMachineId** (*string*) -- **[REQUIRED]** The ID of the SVM that you want to update, in the format "svm- 0123456789abcdef0". * **SvmAdminPassword** (*string*) -- Specifies a new SvmAdminPassword. Return type: dict Returns: **Response Syntax** { 'StorageVirtualMachine': { 'ActiveDirectoryConfiguration': { 'NetBiosName': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] } }, 'CreationTime': datetime(2015, 1, 1), 'Endpoints': { 'Iscsi': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Nfs': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Smb': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'FileSystemId': 'string', 'Lifecycle': 'CREATED'|'CREATING'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING', 'Name': 'string', 'ResourceARN': 'string', 'StorageVirtualMachineId': 'string', 'Subtype': 'DEFAULT'|'DP_DESTINATION'|'SYNC_DESTINATION'|'SYNC_SOURCE', 'UUID': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'LifecycleTransitionReason': { 'Message': 'string' }, 'RootVolumeSecurityStyle': 'UNIX'|'NTFS'|'MIXED' } } **Response Structure** * *(dict) --* * **StorageVirtualMachine** *(dict) --* Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration. * **ActiveDirectoryConfiguration** *(dict) --* Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable. * **NetBiosName** *(string) --* The NetBIOS name of the AD computer object to which the SVM is joined. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self-managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self- managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Endpoints** *(dict) --* The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the "Iscsi", "Management", "Nfs", and "Smb" endpoints. * **Iscsi** *(dict) --* An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Management** *(dict) --* An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Nfs** *(dict) --* An endpoint for connecting using the Network File System (NFS) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Smb** *(dict) --* An endpoint for connecting using the Server Message Block (SMB) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* Describes the SVM's lifecycle status. * "CREATED" - The SVM is fully available for use. * "CREATING" - Amazon FSx is creating the new SVM. * "DELETING" - Amazon FSx is deleting an existing SVM. * "FAILED" - Amazon FSx was unable to create the SVM. * "MISCONFIGURED" - The SVM is in a failed but recoverable state. * "PENDING" - Amazon FSx has not started creating the SVM. * **Name** *(string) --* The name of the SVM, if provisioned. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **StorageVirtualMachineId** *(string) --* The SVM's system generated unique ID. * **Subtype** *(string) --* Describes the SVM's subtype. * **UUID** *(string) --* The SVM's UUID (universally unique identifier). * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **LifecycleTransitionReason** *(dict) --* Describes why the SVM lifecycle state changed. * **Message** *(string) --* A detailed error message. * **RootVolumeSecurityStyle** *(string) --* The security style of the root volume of the SVM. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.StorageVirtualMachineNotFound" * "FSx.Client.exceptions.UnsupportedOperation" FSx / Client / describe_file_caches describe_file_caches ******************** FSx.Client.describe_file_caches(**kwargs) Returns the description of a specific Amazon File Cache resource, if a "FileCacheIds" value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all cache descriptions, you can optionally specify the "MaxResults" parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a "NextToken" value in the response. In this case, send a later request with the "NextToken" request parameter set to the value of "NextToken" from the last response. This operation is used in an iterative process to retrieve a list of your cache descriptions. "DescribeFileCaches" is called first without a "NextToken``value. Then the operation continues to be called with the ``NextToken" parameter set to the value of the last "NextToken" value until a response has no "NextToken". When using this operation, keep the following in mind: * The implementation might return fewer than "MaxResults" cache descriptions while still including a "NextToken" value. * The order of caches returned in the response of one "DescribeFileCaches" call and the order of caches returned across the responses of a multicall iteration is unspecified. See also: AWS API Documentation **Request Syntax** response = client.describe_file_caches( FileCacheIds=[ 'string', ], MaxResults=123, NextToken='string' ) Parameters: * **FileCacheIds** (*list*) -- IDs of the caches whose descriptions you want to retrieve (String). * *(string) --* * **MaxResults** (*integer*) -- The maximum number of resources to return in the response. This value must be an integer greater than zero. * **NextToken** (*string*) -- (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous "NextToken" value left off. Return type: dict Returns: **Response Syntax** { 'FileCaches': [ { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileCacheId': 'string', 'FileCacheType': 'LUSTRE', 'FileCacheTypeVersion': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'UPDATING'|'FAILED', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'LustreConfiguration': { 'PerUnitStorageThroughput': 123, 'DeploymentType': 'CACHE_1', 'MountName': 'string', 'WeeklyMaintenanceStartTime': 'string', 'MetadataConfiguration': { 'StorageCapacity': 123 }, 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' } }, 'DataRepositoryAssociationIds': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **FileCaches** *(list) --* The response object for the "DescribeFileCaches" operation. * *(dict) --* A description of a specific Amazon File Cache resource, which is a response object from the "DescribeFileCaches" operation. * **OwnerId** *(string) --* An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileCacheId** *(string) --* The system-generated, unique ID of the cache. * **FileCacheType** *(string) --* The type of cache, which must be "LUSTRE". * **FileCacheTypeVersion** *(string) --* The Lustre version of the cache, which must be "2.12". * **Lifecycle** *(string) --* The lifecycle status of the cache. The following are the possible values and what they mean: * "AVAILABLE" - The cache is in a healthy state, and is reachable and available for use. * "CREATING" - The new cache is being created. * "DELETING" - An existing cache is being deleted. * "UPDATING" - The cache is undergoing a customer- initiated update. * "FAILED" - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the cache in gibibytes (GiB). * **VpcId** *(string) --* The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide*. * **SubnetIds** *(list) --* A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the "CreateFileCache" operation. * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* A list of network interface IDs. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the cache. * **KmsKeyId** *(string) --* Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a "KmsKeyId" isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the *Key Management Service API Reference*. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **LustreConfiguration** *(dict) --* The configuration for the Amazon File Cache resource. * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only supported value is "1000". * **DeploymentType** *(string) --* The deployment type of the Amazon File Cache resource, which must be "CACHE_1". * **MountName** *(string) --* You use the "MountName" value when mounting the cache. If you pass a cache ID to the "DescribeFileCaches" operation, it returns the the "MountName" value as part of the cache's description. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **MetadataConfiguration** *(dict) --* The configuration for a Lustre MDT (Metadata Target) storage volume. * **StorageCapacity** *(integer) --* The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is "2400" GiB. * **LogConfiguration** *(dict) --* The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **DataRepositoryAssociationIds** *(list) --* A list of IDs of data repository associations that are associated with this cache. * *(string) --* * **NextToken** *(string) --* (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous "NextToken" value left off. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.FileCacheNotFound" * "FSx.Client.exceptions.InternalServerError" FSx / Client / update_volume update_volume ************* FSx.Client.update_volume(**kwargs) Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. See also: AWS API Documentation **Request Syntax** response = client.update_volume( ClientRequestToken='string', VolumeId='string', OntapConfiguration={ 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'VolumeAppendModeEnabled': True|False }, 'SizeInBytes': 123 }, Name='string', OpenZFSConfiguration={ 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'ReadOnly': True|False } ) type ClientRequestToken: string param ClientRequestToken: (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type VolumeId: string param VolumeId: **[REQUIRED]** The ID of the volume that you want to update, in the format "fsvol-0123456789abcdef0". type OntapConfiguration: dict param OntapConfiguration: The configuration of the ONTAP volume that you are updating. * **JunctionPath** *(string) --* Specifies the location in the SVM's namespace where the volume is mounted. The "JunctionPath" must have a leading forward slash, such as "/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* Specifies the size of the volume in megabytes. * **StorageEfficiencyEnabled** *(boolean) --* Default is "false". Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume. * **TieringPolicy** *(dict) --* Update the volume's data tiering policy. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the *Amazon FSx for NetApp ONTAP User Guide*. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* **[REQUIRED]** The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* **[REQUIRED]** The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* **[REQUIRED]** The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. type Name: string param Name: The name of the OpenZFS volume. OpenZFS root volumes are automatically named "FSX". Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume. type OpenZFSConfiguration: dict param OpenZFSConfiguration: The configuration of the OpenZFS volume that you are updating. * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of "-1" to unset a volume's storage capacity reservation. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of "-1" to unset a volume's storage capacity quota. * **RecordSizeKiB** *(integer) --* Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* **[REQUIRED]** A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* **[REQUIRED]** A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* **[REQUIRED]** The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* **[REQUIRED]** Specifies whether the quota applies to a user or group. * **Id** *(integer) --* **[REQUIRED]** The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* **[REQUIRED]** The user or group's storage quota, in gibibytes (GiB). * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read-only. rtype: dict returns: **Response Syntax** { 'Volume': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': {'... recursive ...'}, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } } } **Response Structure** * *(dict) --* * **Volume** *(dict) --* A description of the volume just updated. Returned after a successful "UpdateVolume" API operation. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi- AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket /optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in- transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent- Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi- AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read- only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.MissingVolumeConfiguration" * "FSx.Client.exceptions.VolumeNotFound" FSx / Client / delete_file_cache delete_file_cache ***************** FSx.Client.delete_file_cache(**kwargs) Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone. The "DeleteFileCache" operation returns while the cache has the "DELETING" status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the "DescribeFileCaches" operation returns a "FileCacheNotFound" error. Warning: The data in a deleted cache is also deleted and can't be recovered by any means. See also: AWS API Documentation **Request Syntax** response = client.delete_file_cache( FileCacheId='string', ClientRequestToken='string' ) Parameters: * **FileCacheId** (*string*) -- **[REQUIRED]** The ID of the cache that's being deleted. * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'FileCacheId': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'UPDATING'|'FAILED' } **Response Structure** * *(dict) --* * **FileCacheId** *(string) --* The ID of the cache that's being deleted. * **Lifecycle** *(string) --* The cache lifecycle for the deletion request. If the "DeleteFileCache" operation is successful, this status is "DELETING". **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.FileCacheNotFound" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.InternalServerError" FSx / Client / list_tags_for_resource list_tags_for_resource ********************** FSx.Client.list_tags_for_resource(**kwargs) Lists tags for Amazon FSx resources. When retrieving all tags, you can optionally specify the "MaxResults" parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a "NextToken" value in the response. In this case, send a later request with the "NextToken" request parameter set to the value of "NextToken" from the last response. This action is used in an iterative process to retrieve a list of your tags. "ListTagsForResource" is called first without a "NextToken``value. Then the action continues to be called with the ``NextToken" parameter set to the value of the last "NextToken" value until a response has no "NextToken". When using this action, keep the following in mind: * The implementation might return fewer than "MaxResults" file system descriptions while still including a "NextToken" value. * The order of tags returned in the response of one "ListTagsForResource" call and the order of tags returned across the responses of a multi-call iteration is unspecified. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceARN='string', MaxResults=123, NextToken='string' ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the Amazon FSx resource that will have its tags listed. * **MaxResults** (*integer*) -- Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the "MaxResults" parameter specified in the request and the service's internal maximum number of items per page. * **NextToken** (*string*) -- Opaque pagination token returned from a previous "ListTagsForResource" operation (String). If a token present, the action continues the list from where the returning call left off. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response object for "ListTagsForResource" operation. * **Tags** *(list) --* A list of tags on the resource. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **NextToken** *(string) --* This is present if there are more tags than returned in the response (String). You can use the "NextToken" value in the later request to fetch the tags. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.ResourceNotFound" * "FSx.Client.exceptions.NotServiceResourceError" * "FSx.Client.exceptions.ResourceDoesNotSupportTagging" **Examples** This operation lists tags for an Amazon FSx resource. response = client.list_tags_for_resource( ResourceARN='arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec', ) print(response) Expected Output: { 'Tags': [ { 'Key': 'Name', 'Value': 'MyFileSystem', }, ], 'ResponseMetadata': { '...': '...', }, } FSx / Client / create_volume_from_backup create_volume_from_backup ************************* FSx.Client.create_volume_from_backup(**kwargs) Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup. See also: AWS API Documentation **Request Syntax** response = client.create_volume_from_backup( BackupId='string', ClientRequestToken='string', Name='string', OntapConfiguration={ 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'OntapVolumeType': 'RW'|'DP', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'ConstituentsPerAggregate': 123 }, 'SizeInBytes': 123 }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) type BackupId: string param BackupId: **[REQUIRED]** The ID of the source backup. Specifies the backup that you are copying. type ClientRequestToken: string param ClientRequestToken: (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type Name: string param Name: **[REQUIRED]** The name of the new volume you're creating. type OntapConfiguration: dict param OntapConfiguration: Specifies the configuration of the ONTAP volume that you are creating. * **JunctionPath** *(string) --* Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The "JunctionPath" must have a leading forward slash, such as "/vol3". * **SecurityStyle** *(string) --* Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values: * "UNIX" if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. * "NTFS" if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. * "MIXED" This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center. For more information, see Volume security style in the FSx for ONTAP User Guide. * **SizeInMegabytes** *(integer) --* Use "SizeInBytes" instead. Specifies the size of the volume, in megabytes (MB), that you are creating. * **StorageEfficiencyEnabled** *(boolean) --* Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. "StorageEfficiencyEnabled" is required when creating a "RW" volume ( "OntapVolumeType" set to "RW"). * **StorageVirtualMachineId** *(string) --* **[REQUIRED]** Specifies the ONTAP SVM in which to create the volume. * **TieringPolicy** *(dict) --* Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns. Valid tiering policies are the following: * "SNAPSHOT_ONLY" - (Default value) moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **OntapVolumeType** *(string) --* Specifies the type of volume you are creating. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. A "DP" volume is read-only and can be used as the destination of a NetApp SnapMirror relationship. For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* Specifies the SnapLock configuration for an FSx for ONTAP volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* **[REQUIRED]** The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* **[REQUIRED]** The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* **[REQUIRED]** The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* **[REQUIRED]** Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* Use to specify configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* Used to specify the names of aggregates on which the volume will be created. * *(string) --* * **ConstituentsPerAggregate** *(integer) --* Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume. * **SizeInBytes** *(integer) --* Specifies the configured size of the volume, in bytes. type Tags: list param Tags: A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". rtype: dict returns: **Response Syntax** { 'Volume': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': {'... recursive ...'}, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } } } **Response Structure** * *(dict) --* * **Volume** *(dict) --* Returned after a successful "CreateVolumeFromBackup" API operation, describing the volume just created. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi- AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket /optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in- transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent- Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi- AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read- only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. **Exceptions** * "FSx.Client.exceptions.BackupNotFound" * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.MissingVolumeConfiguration" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.StorageVirtualMachineNotFound" FSx / Client / untag_resource untag_resource ************** FSx.Client.untag_resource(**kwargs) This action removes a tag from an Amazon FSx resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceARN='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The ARN of the Amazon FSx resource to untag. * **TagKeys** (*list*) -- **[REQUIRED]** A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent. * *(string) --* A string of 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the resource to which they are attached. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* The response object for "UntagResource" action. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.ResourceNotFound" * "FSx.Client.exceptions.NotServiceResourceError" * "FSx.Client.exceptions.ResourceDoesNotSupportTagging" **Examples** This operation untags an Amazon FSx resource. response = client.untag_resource( ResourceARN='arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec', TagKeys=[ 'Name', ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } FSx / Client / create_data_repository_association create_data_repository_association ********************************** FSx.Client.create_data_repository_association(**kwargs) Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding "scratch_1" deployment type. Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket. Note: "CreateDataRepositoryAssociation" isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the "CreateFileCache" operation. See also: AWS API Documentation **Request Syntax** response = client.create_data_repository_association( FileSystemId='string', FileSystemPath='string', DataRepositoryPath='string', BatchImportMetaDataOnCreate=True|False, ImportedFileChunkSize=123, S3={ 'AutoImportPolicy': { 'Events': [ 'NEW'|'CHANGED'|'DELETED', ] }, 'AutoExportPolicy': { 'Events': [ 'NEW'|'CHANGED'|'DELETED', ] } }, ClientRequestToken='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **FileSystemId** (*string*) -- **[REQUIRED]** The globally unique ID of the file system, assigned by Amazon FSx. * **FileSystemPath** (*string*) -- A path on the file system that points to a high-level directory (such as "/ns1/") or subdirectory (such as "/ns1/subdir/") that will be mapped 1-1 with "DataRepositoryPath". The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path "/ns1/", then you cannot link another data repository with file system path "/ns1/ns2". This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory. Note: If you specify only a forward slash ( "/") as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system. * **DataRepositoryPath** (*string*) -- **[REQUIRED]** The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format "s3://bucket-name/prefix/" (where "prefix" is optional). This path specifies where in the S3 data repository files will be imported from or exported to. * **BatchImportMetaDataOnCreate** (*boolean*) -- Set to "true" to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is "false". * **ImportedFileChunkSize** (*integer*) -- For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **S3** (*dict*) -- The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository. * **AutoImportPolicy** *(dict) --* Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system. * **Events** *(list) --* The "AutoImportPolicy" can have the following event values: * "NEW" - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. * "CHANGED" - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. * "DELETED" - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. You can define any combination of event types for your "AutoImportPolicy". * *(string) --* * **AutoExportPolicy** *(dict) --* Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket. * **Events** *(list) --* The "AutoExportPolicy" can have the following event values: * "NEW" - New files and directories are automatically exported to the data repository as they are added to the file system. * "CHANGED" - Changes to files and directories on the file system are automatically exported to the data repository. * "DELETED" - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your "AutoExportPolicy". * *(string) --* * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **Tags** (*list*) -- A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". Return type: dict Returns: **Response Syntax** { 'Association': { 'AssociationId': 'string', 'ResourceARN': 'string', 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'FailureDetails': { 'Message': 'string' }, 'FileSystemPath': 'string', 'DataRepositoryPath': 'string', 'BatchImportMetaDataOnCreate': True|False, 'ImportedFileChunkSize': 123, 'S3': { 'AutoImportPolicy': { 'Events': [ 'NEW'|'CHANGED'|'DELETED', ] }, 'AutoExportPolicy': { 'Events': [ 'NEW'|'CHANGED'|'DELETED', ] } }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'CreationTime': datetime(2015, 1, 1), 'FileCacheId': 'string', 'FileCachePath': 'string', 'DataRepositorySubdirectories': [ 'string', ], 'NFS': { 'Version': 'NFS3', 'DnsIps': [ 'string', ], 'AutoExportPolicy': { 'Events': [ 'NEW'|'CHANGED'|'DELETED', ] } } } } **Response Structure** * *(dict) --* * **Association** *(dict) --* The response object returned after the data repository association is created. * **AssociationId** *(string) --* The system-generated, unique ID of the data repository association. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* Describes the state of a data repository association. The lifecycle can have the following values: * "CREATING" - The data repository association between the file system or cache and the data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository association is available for use. * "MISCONFIGURED" - The data repository association is misconfigured. Until the configuration is corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre). * "UPDATING" - The data repository association is undergoing a customer initiated update that might affect its availability. * "DELETING" - The data repository association is undergoing a customer initiated deletion. * "FAILED" - The data repository association is in a terminal state that cannot be recovered. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **FileSystemPath** *(string) --* A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as "/ns1/") or subdirectory (such as "/ns1/subdir/") that will be mapped 1-1 with "DataRepositoryPath". The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path "/ns1/", then you cannot link another data repository with file system path "/ns1/ns2". This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory. Note: If you specify only a forward slash ( "/") as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system. * **DataRepositoryPath** *(string) --* The path to the data repository that will be linked to the cache or file system. * For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats: * If you are not using the "DataRepositorySubdirectories" parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format "nsf://nfs-domain- name/exportpath". You can therefore link a single NFS Export to a single data repository association. * If you are using the "DataRepositorySubdirectories" parameter, the path is the domain name of the NFS file system in the format "nfs://filer-domain-name", which indicates the root of the subdirectories specified with the "DataRepositorySubdirectories" parameter. * For Amazon File Cache, the path can be an S3 bucket or prefix in the format "s3://bucket-name/prefix/" (where "prefix" is optional). * For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format "s3://bucket-name/prefix/" (where "prefix" is optional). * **BatchImportMetaDataOnCreate** *(boolean) --* A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to "true". Note: "BatchImportMetaDataOnCreate" is not supported for data repositories linked to an Amazon File Cache resource. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **S3** *(dict) --* The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association. * **AutoImportPolicy** *(dict) --* Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system. * **Events** *(list) --* The "AutoImportPolicy" can have the following event values: * "NEW" - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. * "CHANGED" - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. * "DELETED" - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. You can define any combination of event types for your "AutoImportPolicy". * *(string) --* * **AutoExportPolicy** *(dict) --* Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket. * **Events** *(list) --* The "AutoExportPolicy" can have the following event values: * "NEW" - New files and directories are automatically exported to the data repository as they are added to the file system. * "CHANGED" - Changes to files and directories on the file system are automatically exported to the data repository. * "DELETED" - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your "AutoExportPolicy". * *(string) --* * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileCacheId** *(string) --* The globally unique ID of the Amazon File Cache resource. * **FileCachePath** *(string) --* A path on the Amazon File Cache that points to a high- level directory (such as "/ns1/") or subdirectory (such as "/ns1/subdir/") that will be mapped 1-1 with "DataRepositoryPath". The leading forward slash in the path is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path "/ns1/", then you cannot link another data repository with cache path "/ns1/ns2". This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and no other data repository can be linked to the directory. Note: The cache path can only be set to root (/) on an NFS DRA when "DataRepositorySubdirectories" is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.The cache path cannot be set to root (/) for an S3 DRA. * **DataRepositorySubdirectories** *(list) --* For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association. All the subdirectories must be on a single NFS file system. The Export paths are in the format "/exportpath1". To use this parameter, you must configure "DataRepositoryPath" as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that "DataRepositorySubdirectories" is not supported for S3 data repositories. * *(string) --* * **NFS** *(dict) --* The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association. * **Version** *(string) --* The version of the NFS (Network File System) protocol of the NFS data repository. Currently, the only supported value is "NFS3", which indicates that the data repository must support the NFSv3 protocol. * **DnsIps** *(list) --* A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on- premises DNS servers. * *(string) --* * **AutoExportPolicy** *(dict) --* This parameter is not supported for Amazon File Cache. * **Events** *(list) --* The "AutoExportPolicy" can have the following event values: * "NEW" - New files and directories are automatically exported to the data repository as they are added to the file system. * "CHANGED" - Changes to files and directories on the file system are automatically exported to the data repository. * "DELETED" - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your "AutoExportPolicy". * *(string) --* **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.UnsupportedOperation" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.InternalServerError" FSx / Client / get_waiter get_waiter ********** FSx.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" FSx / Client / update_file_cache update_file_cache ***************** FSx.Client.update_file_cache(**kwargs) Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request. See also: AWS API Documentation **Request Syntax** response = client.update_file_cache( FileCacheId='string', ClientRequestToken='string', LustreConfiguration={ 'WeeklyMaintenanceStartTime': 'string' } ) Parameters: * **FileCacheId** (*string*) -- **[REQUIRED]** The ID of the cache that you are updating. * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **LustreConfiguration** (*dict*) -- The configuration updates for an Amazon File Cache resource. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. Return type: dict Returns: **Response Syntax** { 'FileCache': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileCacheId': 'string', 'FileCacheType': 'LUSTRE', 'FileCacheTypeVersion': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'UPDATING'|'FAILED', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'LustreConfiguration': { 'PerUnitStorageThroughput': 123, 'DeploymentType': 'CACHE_1', 'MountName': 'string', 'WeeklyMaintenanceStartTime': 'string', 'MetadataConfiguration': { 'StorageCapacity': 123 }, 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' } }, 'DataRepositoryAssociationIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **FileCache** *(dict) --* A description of the cache that was updated. * **OwnerId** *(string) --* An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileCacheId** *(string) --* The system-generated, unique ID of the cache. * **FileCacheType** *(string) --* The type of cache, which must be "LUSTRE". * **FileCacheTypeVersion** *(string) --* The Lustre version of the cache, which must be "2.12". * **Lifecycle** *(string) --* The lifecycle status of the cache. The following are the possible values and what they mean: * "AVAILABLE" - The cache is in a healthy state, and is reachable and available for use. * "CREATING" - The new cache is being created. * "DELETING" - An existing cache is being deleted. * "UPDATING" - The cache is undergoing a customer- initiated update. * "FAILED" - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the cache in gibibytes (GiB). * **VpcId** *(string) --* The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide*. * **SubnetIds** *(list) --* A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the "CreateFileCache" operation. * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* A list of network interface IDs. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the cache. * **KmsKeyId** *(string) --* Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a "KmsKeyId" isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the *Key Management Service API Reference*. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **LustreConfiguration** *(dict) --* The configuration for the Amazon File Cache resource. * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only supported value is "1000". * **DeploymentType** *(string) --* The deployment type of the Amazon File Cache resource, which must be "CACHE_1". * **MountName** *(string) --* You use the "MountName" value when mounting the cache. If you pass a cache ID to the "DescribeFileCaches" operation, it returns the the "MountName" value as part of the cache's description. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **MetadataConfiguration** *(dict) --* The configuration for a Lustre MDT (Metadata Target) storage volume. * **StorageCapacity** *(integer) --* The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is "2400" GiB. * **LogConfiguration** *(dict) --* The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **DataRepositoryAssociationIds** *(list) --* A list of IDs of data repository associations that are associated with this cache. * *(string) --* **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.UnsupportedOperation" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.FileCacheNotFound" * "FSx.Client.exceptions.MissingFileCacheConfiguration" * "FSx.Client.exceptions.ServiceLimitExceeded" FSx / Client / create_storage_virtual_machine create_storage_virtual_machine ****************************** FSx.Client.create_storage_virtual_machine(**kwargs) Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system. See also: AWS API Documentation **Request Syntax** response = client.create_storage_virtual_machine( ActiveDirectoryConfiguration={ 'NetBiosName': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'Password': 'string', 'DnsIps': [ 'string', ] } }, ClientRequestToken='string', FileSystemId='string', Name='string', SvmAdminPassword='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], RootVolumeSecurityStyle='UNIX'|'NTFS'|'MIXED' ) Parameters: * **ActiveDirectoryConfiguration** (*dict*) -- Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system. * **NetBiosName** *(string) --* **[REQUIRED]** The NetBIOS name of the Active Directory computer object that will be created for your SVM. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on- premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs. * **DomainName** *(string) --* **[REQUIRED]** The fully qualified domain name of the self-managed AD directory, such as "corp.example.com". * **OrganizationalUnitDistinguishedName** *(string) --* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is "OU=FSx,DC=yourdomain,DC=corp,DC=com". To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. Warning: Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. * **FileSystemAdministratorsGroup** *(string) --* (Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used. * **UserName** *(string) --* **[REQUIRED]** The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in "OrganizationalUnitDistinguishedName", or in the default location of your AD domain. * **Password** *(string) --* **[REQUIRED]** The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. * **DnsIps** *(list) --* **[REQUIRED]** A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **FileSystemId** (*string*) -- **[REQUIRED]** The globally unique ID of the file system, assigned by Amazon FSx. * **Name** (*string*) -- **[REQUIRED]** The name of the SVM. * **SvmAdminPassword** (*string*) -- The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's "fsxadmin" user to manage the SVM. * **Tags** (*list*) -- A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **RootVolumeSecurityStyle** (*string*) -- The security style of the root volume of the SVM. Specify one of the following values: * "UNIX" if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. * "NTFS" if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account. * "MIXED" This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Return type: dict Returns: **Response Syntax** { 'StorageVirtualMachine': { 'ActiveDirectoryConfiguration': { 'NetBiosName': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] } }, 'CreationTime': datetime(2015, 1, 1), 'Endpoints': { 'Iscsi': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Nfs': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Smb': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'FileSystemId': 'string', 'Lifecycle': 'CREATED'|'CREATING'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING', 'Name': 'string', 'ResourceARN': 'string', 'StorageVirtualMachineId': 'string', 'Subtype': 'DEFAULT'|'DP_DESTINATION'|'SYNC_DESTINATION'|'SYNC_SOURCE', 'UUID': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'LifecycleTransitionReason': { 'Message': 'string' }, 'RootVolumeSecurityStyle': 'UNIX'|'NTFS'|'MIXED' } } **Response Structure** * *(dict) --* * **StorageVirtualMachine** *(dict) --* Returned after a successful "CreateStorageVirtualMachine" operation; describes the SVM just created. * **ActiveDirectoryConfiguration** *(dict) --* Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable. * **NetBiosName** *(string) --* The NetBIOS name of the AD computer object to which the SVM is joined. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self-managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self- managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Endpoints** *(dict) --* The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the "Iscsi", "Management", "Nfs", and "Smb" endpoints. * **Iscsi** *(dict) --* An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Management** *(dict) --* An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Nfs** *(dict) --* An endpoint for connecting using the Network File System (NFS) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **Smb** *(dict) --* An endpoint for connecting using the Server Message Block (SMB) protocol. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* The SVM endpoint's IP addresses. * *(string) --* * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* Describes the SVM's lifecycle status. * "CREATED" - The SVM is fully available for use. * "CREATING" - Amazon FSx is creating the new SVM. * "DELETING" - Amazon FSx is deleting an existing SVM. * "FAILED" - Amazon FSx was unable to create the SVM. * "MISCONFIGURED" - The SVM is in a failed but recoverable state. * "PENDING" - Amazon FSx has not started creating the SVM. * **Name** *(string) --* The name of the SVM, if provisioned. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **StorageVirtualMachineId** *(string) --* The SVM's system generated unique ID. * **Subtype** *(string) --* Describes the SVM's subtype. * **UUID** *(string) --* The SVM's UUID (universally unique identifier). * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **LifecycleTransitionReason** *(dict) --* Describes why the SVM lifecycle state changed. * **Message** *(string) --* A detailed error message. * **RootVolumeSecurityStyle** *(string) --* The security style of the root volume of the SVM. **Exceptions** * "FSx.Client.exceptions.ActiveDirectoryError" * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.UnsupportedOperation" FSx / Client / delete_data_repository_association delete_data_repository_association ********************************** FSx.Client.delete_data_repository_association(**kwargs) Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding "scratch_1" deployment type. See also: AWS API Documentation **Request Syntax** response = client.delete_data_repository_association( AssociationId='string', ClientRequestToken='string', DeleteDataInFileSystem=True|False ) Parameters: * **AssociationId** (*string*) -- **[REQUIRED]** The ID of the data repository association that you want to delete. * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **DeleteDataInFileSystem** (*boolean*) -- Set to "true" to delete the data in the file system that corresponds to the data repository association. Return type: dict Returns: **Response Syntax** { 'AssociationId': 'string', 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'DeleteDataInFileSystem': True|False } **Response Structure** * *(dict) --* * **AssociationId** *(string) --* The ID of the data repository association being deleted. * **Lifecycle** *(string) --* Describes the lifecycle state of the data repository association being deleted. * **DeleteDataInFileSystem** *(boolean) --* Indicates whether data in the file system that corresponds to the data repository association is being deleted. Default is "false". **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.DataRepositoryAssociationNotFound" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.InternalServerError" FSx / Client / create_volume create_volume ************* FSx.Client.create_volume(**kwargs) Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume. See also: AWS API Documentation **Request Syntax** response = client.create_volume( ClientRequestToken='string', VolumeType='ONTAP'|'OPENZFS', Name='string', OntapConfiguration={ 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'OntapVolumeType': 'RW'|'DP', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'ConstituentsPerAggregate': 123 }, 'SizeInBytes': 123 }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], OpenZFSConfiguration={ 'ParentVolumeId': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ] } ) type ClientRequestToken: string param ClientRequestToken: (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type VolumeType: string param VolumeType: **[REQUIRED]** Specifies the type of volume to create; "ONTAP" and "OPENZFS" are the only valid volume types. type Name: string param Name: **[REQUIRED]** Specifies the name of the volume that you're creating. type OntapConfiguration: dict param OntapConfiguration: Specifies the configuration to use when creating the ONTAP volume. * **JunctionPath** *(string) --* Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The "JunctionPath" must have a leading forward slash, such as "/vol3". * **SecurityStyle** *(string) --* Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values: * "UNIX" if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. * "NTFS" if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. * "MIXED" This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center. For more information, see Volume security style in the FSx for ONTAP User Guide. * **SizeInMegabytes** *(integer) --* Use "SizeInBytes" instead. Specifies the size of the volume, in megabytes (MB), that you are creating. * **StorageEfficiencyEnabled** *(boolean) --* Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. "StorageEfficiencyEnabled" is required when creating a "RW" volume ( "OntapVolumeType" set to "RW"). * **StorageVirtualMachineId** *(string) --* **[REQUIRED]** Specifies the ONTAP SVM in which to create the volume. * **TieringPolicy** *(dict) --* Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns. Valid tiering policies are the following: * "SNAPSHOT_ONLY" - (Default value) moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **OntapVolumeType** *(string) --* Specifies the type of volume you are creating. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. A "DP" volume is read-only and can be used as the destination of a NetApp SnapMirror relationship. For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* Specifies the SnapLock configuration for an FSx for ONTAP volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* **[REQUIRED]** The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* **[REQUIRED]** The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* **[REQUIRED]** The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* **[REQUIRED]** Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* **[REQUIRED]** Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* Use to specify configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* Used to specify the names of aggregates on which the volume will be created. * *(string) --* * **ConstituentsPerAggregate** *(integer) --* Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume. * **SizeInBytes** *(integer) --* Specifies the configured size of the volume, in bytes. type Tags: list param Tags: A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". type OpenZFSConfiguration: dict param OpenZFSConfiguration: Specifies the configuration to use when creating the OpenZFS volume. * **ParentVolumeId** *(string) --* **[REQUIRED]** The ID of the volume to use as the parent volume of the volume that you are creating. * **StorageCapacityReservationGiB** *(integer) --* Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting "StorageCapacityReservationGiB" guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To *not* specify a storage capacity reservation, set this to "0" or "-1". For more information, see Volume properties in the *Amazon FSx for OpenZFS User Guide*. * **StorageCapacityQuotaGiB** *(integer) --* Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set "StorageCapacityReservationGiB". To *not* specify a storage capacity quota, set this to "-1". For more information, see Volume properties in the *Amazon FSx for OpenZFS User Guide*. * **RecordSizeKiB** *(integer) --* Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression. For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the *Amazon FSx for OpenZFS User Guide*. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If this value is set to  "true", and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to "true", and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* **[REQUIRED]** Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read-only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* **[REQUIRED]** A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* **[REQUIRED]** A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* **[REQUIRED]** The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* Configures how much storage users and groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* **[REQUIRED]** Specifies whether the quota applies to a user or group. * **Id** *(integer) --* **[REQUIRED]** The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* **[REQUIRED]** The user or group's storage quota, in gibibytes (GiB). rtype: dict returns: **Response Syntax** { 'Volume': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': {'... recursive ...'}, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ], 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } } } **Response Structure** * *(dict) --* * **Volume** *(dict) --* Returned after a successful "CreateVolume" API operation, describing the volume just created. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update-volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi- AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket /optional-prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in- transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent- Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi- AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user- initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read- only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.MissingVolumeConfiguration" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.StorageVirtualMachineNotFound" * "FSx.Client.exceptions.UnsupportedOperation" FSx / Client / delete_volume delete_volume ************* FSx.Client.delete_volume(**kwargs) Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. See also: AWS API Documentation **Request Syntax** response = client.delete_volume( ClientRequestToken='string', VolumeId='string', OntapConfiguration={ 'SkipFinalBackup': True|False, 'FinalBackupTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'BypassSnaplockEnterpriseRetention': True|False }, OpenZFSConfiguration={ 'Options': [ 'DELETE_CHILD_VOLUMES_AND_SNAPSHOTS', ] } ) Parameters: * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the volume that you are deleting. * **OntapConfiguration** (*dict*) -- For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the "fsx:TagResource" permission. * **SkipFinalBackup** *(boolean) --* Set to true if you want to skip taking a final backup of the volume you are deleting. * **FinalBackupTags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **BypassSnaplockEnterpriseRetention** *(boolean) --* Setting this to "true" allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. The IAM permission "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. * **OpenZFSConfiguration** (*dict*) -- For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots. * **Options** *(list) --* To delete the volume's child volumes, snapshots, and clones, use the string "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS". * *(string) --* Return type: dict Returns: **Response Syntax** { 'VolumeId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'OntapResponse': { 'FinalBackupId': 'string', 'FinalBackupTags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **VolumeId** *(string) --* The ID of the volume that's being deleted. * **Lifecycle** *(string) --* The lifecycle state of the volume being deleted. If the "DeleteVolume" operation is successful, this value is "DELETING". * **OntapResponse** *(dict) --* Returned after a "DeleteVolume" request, showing the status of the delete request. * **FinalBackupId** *(string) --* The ID of the source backup. Specifies the backup that you are copying. * **FinalBackupTags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.VolumeNotFound" * "FSx.Client.exceptions.ServiceLimitExceeded" FSx / Client / copy_snapshot_and_update_volume copy_snapshot_and_update_volume ******************************* FSx.Client.copy_snapshot_and_update_volume(**kwargs) Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide. See also: AWS API Documentation **Request Syntax** response = client.copy_snapshot_and_update_volume( ClientRequestToken='string', VolumeId='string', SourceSnapshotARN='string', CopyStrategy='CLONE'|'FULL_COPY'|'INCREMENTAL_COPY', Options=[ 'DELETE_INTERMEDIATE_SNAPSHOTS'|'DELETE_CLONED_VOLUMES'|'DELETE_INTERMEDIATE_DATA', ] ) type ClientRequestToken: string param ClientRequestToken: (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type VolumeId: string param VolumeId: **[REQUIRED]** Specifies the ID of the volume that you are copying the snapshot to. type SourceSnapshotARN: string param SourceSnapshotARN: **[REQUIRED]** The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. type CopyStrategy: string param CopyStrategy: Specifies the strategy to use when copying data from a snapshot to the volume. * "FULL_COPY" - Copies all data from the snapshot to the volume. * "INCREMENTAL_COPY" - Copies only the snapshot data that's changed since the previous replication. Note: "CLONE" isn't a valid copy strategy option for the "CopySnapshotAndUpdateVolume" operation. type Options: list param Options: Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication. Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include "DELETE_INTERMEDIATE_SNAPSHOTS" and there are intermediate snapshots on the destination, you can’t copy the snapshot. * "DELETE_INTERMEDIATE_SNAPSHOTS" - Deletes snapshots on the destination volume that aren’t on the source volume. * "DELETE_CLONED_VOLUMES" - Deletes snapshot clones on the destination volume that aren't on the source volume. * "DELETE_INTERMEDIATE_DATA" - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying. * *(string) --* rtype: dict returns: **Response Syntax** { 'VolumeId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ] } **Response Structure** * *(dict) --* * **VolumeId** *(string) --* The ID of the volume that you copied the snapshot to. * **Lifecycle** *(string) --* The lifecycle state of the destination volume. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update- volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi-AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi- AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket/optional- prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in-transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent- Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second- generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user- initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load- sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read- only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.ServiceLimitExceeded" FSx / Client / delete_snapshot delete_snapshot *************** FSx.Client.delete_snapshot(**kwargs) Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup. The "DeleteSnapshot" operation returns instantly. The snapshot appears with the lifecycle status of "DELETING" until the deletion is complete. See also: AWS API Documentation **Request Syntax** response = client.delete_snapshot( ClientRequestToken='string', SnapshotId='string' ) Parameters: * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **SnapshotId** (*string*) -- **[REQUIRED]** The ID of the snapshot that you want to delete. Return type: dict Returns: **Response Syntax** { 'SnapshotId': 'string', 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE' } **Response Structure** * *(dict) --* * **SnapshotId** *(string) --* The ID of the deleted snapshot. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. If the "DeleteSnapshot" operation is successful, this status is "DELETING". **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.SnapshotNotFound" FSx / Client / describe_data_repository_tasks describe_data_repository_tasks ****************************** FSx.Client.describe_data_repository_tasks(**kwargs) Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more "TaskIds" values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all tasks, you can paginate the response by using the optional "MaxResults" parameter to limit the number of tasks returned in a response. If more tasks remain, a "NextToken" value is returned in the response. In this case, send a later request with the "NextToken" request parameter set to the value of "NextToken" from the last response. See also: AWS API Documentation **Request Syntax** response = client.describe_data_repository_tasks( TaskIds=[ 'string', ], Filters=[ { 'Name': 'file-system-id'|'task-lifecycle'|'data-repository-association-id'|'file-cache-id', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **TaskIds** (*list*) -- (Optional) IDs of the tasks whose descriptions you want to retrieve (String). * *(string) --* * **Filters** (*list*) -- (Optional) You can use filters to narrow the "DescribeDataRepositoryTasks" response to include just tasks for specific file systems, or tasks in a specific lifecycle state. * *(dict) --* (Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter "Name", and one or more "Values" for the filter. * **Name** *(string) --* Name of the task property to use in filtering the tasks returned in the response. * Use "file-system-id" to retrieve data repository tasks for specific file systems. * Use "task-lifecycle" to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED. * **Values** *(list) --* Use Values to include the specific file system IDs and task lifecycle states for the filters you are using. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of resources to return in the response. This value must be an integer greater than zero. * **NextToken** (*string*) -- (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous "NextToken" value left off. Return type: dict Returns: **Response Syntax** { 'DataRepositoryTasks': [ { 'TaskId': 'string', 'Lifecycle': 'PENDING'|'EXECUTING'|'FAILED'|'SUCCEEDED'|'CANCELED'|'CANCELING', 'Type': 'EXPORT_TO_REPOSITORY'|'IMPORT_METADATA_FROM_REPOSITORY'|'RELEASE_DATA_FROM_FILESYSTEM'|'AUTO_RELEASE_DATA', 'CreationTime': datetime(2015, 1, 1), 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FileSystemId': 'string', 'Paths': [ 'string', ], 'FailureDetails': { 'Message': 'string' }, 'Status': { 'TotalCount': 123, 'SucceededCount': 123, 'FailedCount': 123, 'LastUpdatedTime': datetime(2015, 1, 1), 'ReleasedCapacity': 123 }, 'Report': { 'Enabled': True|False, 'Path': 'string', 'Format': 'REPORT_CSV_20191124', 'Scope': 'FAILED_FILES_ONLY' }, 'CapacityToRelease': 123, 'FileCacheId': 'string', 'ReleaseConfiguration': { 'DurationSinceLastAccess': { 'Unit': 'DAYS', 'Value': 123 } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **DataRepositoryTasks** *(list) --* The collection of data repository task descriptions returned. * *(dict) --* 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 files that have been exported to a linked S3 bucket 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. * **TaskId** *(string) --* The system-generated, unique 17-digit ID of the data repository task. * **Lifecycle** *(string) --* The lifecycle status of the data repository task, as follows: * "PENDING" - The task has not started. * "EXECUTING" - The task is in process. * "FAILED" - The task was not able to be completed. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures. * "SUCCEEDED" - The task has completed successfully. * "CANCELED" - The task was canceled and it did not complete. * "CANCELING" - The task is in process of being canceled. Note: You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the "PENDING" or "EXECUTING" states. Please retry when the data repository task is finished (with a status of "CANCELED", "SUCCEEDED", or "FAILED"). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately. * **Type** *(string) --* The type of data repository task. * "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 have been exported to a linked S3 bucket and that meet your specified release criteria. * "AUTO_RELEASE_DATA" tasks automatically release files from an Amazon File Cache resource. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **StartTime** *(datetime) --* The time the system began processing the task. * **EndTime** *(datetime) --* The time the system completed processing the task, populated after the task is complete. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **FileSystemId** *(string) --* The globally unique ID of the file system. * **Paths** *(list) --* An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository. (Default) If "Paths" is not specified, Amazon FSx uses the file system root directory. * *(string) --* * **FailureDetails** *(dict) --* Failure message describing why the task failed, it is populated only when "Lifecycle" is set to "FAILED". * **Message** *(string) --* A detailed error message. * **Status** *(dict) --* Provides the status of the number of files that the task has processed successfully and failed to process. * **TotalCount** *(integer) --* The total number of files that the task will process. While a task is executing, the sum of "SucceededCount" plus "FailedCount" may not equal "TotalCount". When the task is complete, "TotalCount" equals the sum of "SucceededCount" plus "FailedCount". * **SucceededCount** *(integer) --* A running total of the number of files that the task has successfully processed. * **FailedCount** *(integer) --* A running total of the number of files that the task failed to process. * **LastUpdatedTime** *(datetime) --* The time at which the task status was last updated. * **ReleasedCapacity** *(integer) --* The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache. * **Report** *(dict) --* Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report "Scope" parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report "Path" parameter. You can specify whether or not a report gets generated for a task using the "Enabled" parameter. * **Enabled** *(boolean) --* Set "Enabled" to "True" to generate a "CompletionReport" when the task completes. If set to "true", then you need to provide a report "Scope", "Path", and "Format". Set "Enabled" to "False" if you do not want a "CompletionReport" generated when the task completes. * **Path** *(string) --* Required if "Enabled" is set to "true". Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The "Path" you provide must be located within the file system’s ExportPath. An example "Path" value is "s3://amzn-s3-demo- bucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. * **Format** *(string) --* Required if "Enabled" is set to "true". Specifies the format of the "CompletionReport". "REPORT_CSV_20191124" is the only format currently supported. When "Format" is set to "REPORT_CSV_20191124", the "CompletionReport" is provided in CSV format, and is delivered to "{path}/task-{id}/failures.csv". * **Scope** *(string) --* Required if "Enabled" is set to "true". Specifies the scope of the "CompletionReport"; "FAILED_FILES_ONLY" is the only scope currently supported. When "Scope" is set to "FAILED_FILES_ONLY", the "CompletionReport" only contains information about files that the data repository task failed to process. * **CapacityToRelease** *(integer) --* Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache. * **FileCacheId** *(string) --* The system-generated, unique ID of the cache. * **ReleaseConfiguration** *(dict) --* The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system. * **DurationSinceLastAccess** *(dict) --* Defines the point-in-time since an exported 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. * **Unit** *(string) --* 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. * **Value** *(integer) --* An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported 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. Note: If an exported 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. * **NextToken** *(string) --* (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous "NextToken" value left off. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.DataRepositoryTaskNotFound" * "FSx.Client.exceptions.InternalServerError" FSx / Client / create_data_repository_task create_data_repository_task *************************** FSx.Client.create_data_repository_task(**kwargs) 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 exported 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. See also: AWS API Documentation **Request Syntax** response = client.create_data_repository_task( Type='EXPORT_TO_REPOSITORY'|'IMPORT_METADATA_FROM_REPOSITORY'|'RELEASE_DATA_FROM_FILESYSTEM'|'AUTO_RELEASE_DATA', Paths=[ 'string', ], FileSystemId='string', Report={ 'Enabled': True|False, 'Path': 'string', 'Format': 'REPORT_CSV_20191124', 'Scope': 'FAILED_FILES_ONLY' }, ClientRequestToken='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], CapacityToRelease=123, ReleaseConfiguration={ 'DurationSinceLastAccess': { 'Unit': 'DAYS', 'Value': 123 } } ) Parameters: * **Type** (*string*) -- **[REQUIRED]** 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 have been exported to a linked S3 bucket and that meet your specified release criteria. * "AUTO_RELEASE_DATA" tasks automatically release files from an Amazon File Cache resource. * **Paths** (*list*) -- 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 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 exported files that meet the last accessed time criteria (for release tasks). * 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 "/mnt/fsx/path1" is a directory or file on the file system you want to export, then the path to provide is "path1". * For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format "s3://bucket-name/prefix" (where "prefix" is optional). * For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported 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 exported files in the file system, specify a forward slash (/) as the path. Note: A file must also meet the last accessed time criteria specified in for the file to be released. * *(string) --* * **FileSystemId** (*string*) -- **[REQUIRED]** The globally unique ID of the file system, assigned by Amazon FSx. * **Report** (*dict*) -- **[REQUIRED]** Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the "Scope" parameter. For more information, see Working with Task Completion Reports. * **Enabled** *(boolean) --* **[REQUIRED]** Set "Enabled" to "True" to generate a "CompletionReport" when the task completes. If set to "true", then you need to provide a report "Scope", "Path", and "Format". Set "Enabled" to "False" if you do not want a "CompletionReport" generated when the task completes. * **Path** *(string) --* Required if "Enabled" is set to "true". Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The "Path" you provide must be located within the file system’s ExportPath. An example "Path" value is "s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. * **Format** *(string) --* Required if "Enabled" is set to "true". Specifies the format of the "CompletionReport". "REPORT_CSV_20191124" is the only format currently supported. When "Format" is set to "REPORT_CSV_20191124", the "CompletionReport" is provided in CSV format, and is delivered to "{path}/task-{id}/failures.csv". * **Scope** *(string) --* Required if "Enabled" is set to "true". Specifies the scope of the "CompletionReport"; "FAILED_FILES_ONLY" is the only scope currently supported. When "Scope" is set to "FAILED_FILES_ONLY", the "CompletionReport" only contains information about files that the data repository task failed to process. * **ClientRequestToken** (*string*) -- (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **Tags** (*list*) -- A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **CapacityToRelease** (*integer*) -- Specifies the amount of data to release, in GiB, by an Amazon File Cache "AUTO_RELEASE_DATA" task that automatically releases files from the cache. * **ReleaseConfiguration** (*dict*) -- The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system. * **DurationSinceLastAccess** *(dict) --* Defines the point-in-time since an exported 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. * **Unit** *(string) --* 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. * **Value** *(integer) --* An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported 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. Note: If an exported 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. Return type: dict Returns: **Response Syntax** { 'DataRepositoryTask': { 'TaskId': 'string', 'Lifecycle': 'PENDING'|'EXECUTING'|'FAILED'|'SUCCEEDED'|'CANCELED'|'CANCELING', 'Type': 'EXPORT_TO_REPOSITORY'|'IMPORT_METADATA_FROM_REPOSITORY'|'RELEASE_DATA_FROM_FILESYSTEM'|'AUTO_RELEASE_DATA', 'CreationTime': datetime(2015, 1, 1), 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FileSystemId': 'string', 'Paths': [ 'string', ], 'FailureDetails': { 'Message': 'string' }, 'Status': { 'TotalCount': 123, 'SucceededCount': 123, 'FailedCount': 123, 'LastUpdatedTime': datetime(2015, 1, 1), 'ReleasedCapacity': 123 }, 'Report': { 'Enabled': True|False, 'Path': 'string', 'Format': 'REPORT_CSV_20191124', 'Scope': 'FAILED_FILES_ONLY' }, 'CapacityToRelease': 123, 'FileCacheId': 'string', 'ReleaseConfiguration': { 'DurationSinceLastAccess': { 'Unit': 'DAYS', 'Value': 123 } } } } **Response Structure** * *(dict) --* * **DataRepositoryTask** *(dict) --* The description of the data repository task that you just created. * **TaskId** *(string) --* The system-generated, unique 17-digit ID of the data repository task. * **Lifecycle** *(string) --* The lifecycle status of the data repository task, as follows: * "PENDING" - The task has not started. * "EXECUTING" - The task is in process. * "FAILED" - The task was not able to be completed. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures. * "SUCCEEDED" - The task has completed successfully. * "CANCELED" - The task was canceled and it did not complete. * "CANCELING" - The task is in process of being canceled. Note: You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the "PENDING" or "EXECUTING" states. Please retry when the data repository task is finished (with a status of "CANCELED", "SUCCEEDED", or "FAILED"). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately. * **Type** *(string) --* The type of data repository task. * "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 have been exported to a linked S3 bucket and that meet your specified release criteria. * "AUTO_RELEASE_DATA" tasks automatically release files from an Amazon File Cache resource. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **StartTime** *(datetime) --* The time the system began processing the task. * **EndTime** *(datetime) --* The time the system completed processing the task, populated after the task is complete. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **FileSystemId** *(string) --* The globally unique ID of the file system. * **Paths** *(list) --* An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository. (Default) If "Paths" is not specified, Amazon FSx uses the file system root directory. * *(string) --* * **FailureDetails** *(dict) --* Failure message describing why the task failed, it is populated only when "Lifecycle" is set to "FAILED". * **Message** *(string) --* A detailed error message. * **Status** *(dict) --* Provides the status of the number of files that the task has processed successfully and failed to process. * **TotalCount** *(integer) --* The total number of files that the task will process. While a task is executing, the sum of "SucceededCount" plus "FailedCount" may not equal "TotalCount". When the task is complete, "TotalCount" equals the sum of "SucceededCount" plus "FailedCount". * **SucceededCount** *(integer) --* A running total of the number of files that the task has successfully processed. * **FailedCount** *(integer) --* A running total of the number of files that the task failed to process. * **LastUpdatedTime** *(datetime) --* The time at which the task status was last updated. * **ReleasedCapacity** *(integer) --* The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache. * **Report** *(dict) --* Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report "Scope" parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report "Path" parameter. You can specify whether or not a report gets generated for a task using the "Enabled" parameter. * **Enabled** *(boolean) --* Set "Enabled" to "True" to generate a "CompletionReport" when the task completes. If set to "true", then you need to provide a report "Scope", "Path", and "Format". Set "Enabled" to "False" if you do not want a "CompletionReport" generated when the task completes. * **Path** *(string) --* Required if "Enabled" is set to "true". Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The "Path" you provide must be located within the file system’s ExportPath. An example "Path" value is "s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. * **Format** *(string) --* Required if "Enabled" is set to "true". Specifies the format of the "CompletionReport". "REPORT_CSV_20191124" is the only format currently supported. When "Format" is set to "REPORT_CSV_20191124", the "CompletionReport" is provided in CSV format, and is delivered to "{path}/task-{id}/failures.csv". * **Scope** *(string) --* Required if "Enabled" is set to "true". Specifies the scope of the "CompletionReport"; "FAILED_FILES_ONLY" is the only scope currently supported. When "Scope" is set to "FAILED_FILES_ONLY", the "CompletionReport" only contains information about files that the data repository task failed to process. * **CapacityToRelease** *(integer) --* Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache. * **FileCacheId** *(string) --* The system-generated, unique ID of the cache. * **ReleaseConfiguration** *(dict) --* The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system. * **DurationSinceLastAccess** *(dict) --* Defines the point-in-time since an exported 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. * **Unit** *(string) --* 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. * **Value** *(integer) --* An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported 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. Note: If an exported 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. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.UnsupportedOperation" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.DataRepositoryTaskExecuting" FSx / Client / delete_file_system delete_file_system ****************** FSx.Client.delete_file_system(**kwargs) Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted. To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a "FileSystemId" value to the "DeleteFileSystem" operation. Before deleting an Amazon FSx for OpenZFS file system, make sure that there aren't any Amazon S3 access points attached to any volume. For more information on how to list S3 access points that are attached to volumes, see Listing S3 access point attachments. For more information on how to delete S3 access points, see Deleting an S3 access point attachment. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted. To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a "FileSystemId" value to the "DeleteFileSystem" operation. By default, Amazon FSx will not take a final backup when the "DeleteFileSystem" operation is invoked. On file systems not linked to an Amazon S3 bucket, set "SkipFinalBackup" to "false" to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task. The "DeleteFileSystem" operation returns while the file system has the "DELETING" status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the "DescribeFileSystems" operation returns a "FileSystemNotFound" error. Note: If a data repository task is in a "PENDING" or "EXECUTING" state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request). Warning: The data in a deleted file system is also deleted and can't be recovered by any means. See also: AWS API Documentation **Request Syntax** response = client.delete_file_system( FileSystemId='string', ClientRequestToken='string', WindowsConfiguration={ 'SkipFinalBackup': True|False, 'FinalBackupTags': [ { 'Key': 'string', 'Value': 'string' }, ] }, LustreConfiguration={ 'SkipFinalBackup': True|False, 'FinalBackupTags': [ { 'Key': 'string', 'Value': 'string' }, ] }, OpenZFSConfiguration={ 'SkipFinalBackup': True|False, 'FinalBackupTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Options': [ 'DELETE_CHILD_VOLUMES_AND_SNAPSHOTS', ] } ) Parameters: * **FileSystemId** (*string*) -- **[REQUIRED]** The ID of the file system that you want to delete. * **ClientRequestToken** (*string*) -- A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. * **WindowsConfiguration** (*dict*) -- The configuration object for the Microsoft Windows file system used in the "DeleteFileSystem" operation. * **SkipFinalBackup** *(boolean) --* By default, Amazon FSx for Windows takes a final backup on your behalf when the "DeleteFileSystem" operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so. * **FinalBackupTags** *(list) --* A set of tags for your final backup. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **LustreConfiguration** (*dict*) -- The configuration object for the Amazon FSx for Lustre file system being deleted in the "DeleteFileSystem" operation. * **SkipFinalBackup** *(boolean) --* Set "SkipFinalBackup" to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the "DeleteFileSystem" operation is invoked. (Default = true) Note: The "fsx:CreateBackup" permission is required if you set "SkipFinalBackup" to "false" in order to delete the file system and take a final backup. * **FinalBackupTags** *(list) --* Use if "SkipFinalBackup" is set to "false", and you want to apply an array of tags to the final backup. If you have set the file system property "CopyTagsToBackups" to true, and you specify one or more "FinalBackupTags" when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **OpenZFSConfiguration** (*dict*) -- The configuration object for the OpenZFS file system used in the "DeleteFileSystem" operation. * **SkipFinalBackup** *(boolean) --* By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the "DeleteFileSystem" operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip taking a final backup, set this value to "true". * **FinalBackupTags** *(list) --* A list of tags to apply to the file system's final backup. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **Options** *(list) --* To delete a file system if there are child volumes present below the root volume, use the string "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS". If your file system has child volumes and you don't use this option, the delete request will fail. * *(string) --* Return type: dict Returns: **Response Syntax** { 'FileSystemId': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'WindowsResponse': { 'FinalBackupId': 'string', 'FinalBackupTags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'LustreResponse': { 'FinalBackupId': 'string', 'FinalBackupTags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'OpenZFSResponse': { 'FinalBackupId': 'string', 'FinalBackupTags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* The response object for the "DeleteFileSystem" operation. * **FileSystemId** *(string) --* The ID of the file system that's being deleted. * **Lifecycle** *(string) --* The file system lifecycle for the deletion request. If the "DeleteFileSystem" operation is successful, this status is "DELETING". * **WindowsResponse** *(dict) --* The response object for the Microsoft Windows file system used in the "DeleteFileSystem" operation. * **FinalBackupId** *(string) --* The ID of the final backup for this file system. * **FinalBackupTags** *(list) --* The set of tags applied to the final backup. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **LustreResponse** *(dict) --* The response object for the Amazon FSx for Lustre file system being deleted in the "DeleteFileSystem" operation. * **FinalBackupId** *(string) --* The ID of the final backup for this file system. * **FinalBackupTags** *(list) --* The set of tags applied to the final backup. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **OpenZFSResponse** *(dict) --* The response object for the OpenZFS file system that's being deleted in the "DeleteFileSystem" operation. * **FinalBackupId** *(string) --* The ID of the source backup. Specifies the backup that you are copying. * **FinalBackupTags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.IncompatibleParameterError" * "FSx.Client.exceptions.FileSystemNotFound" * "FSx.Client.exceptions.ServiceLimitExceeded" * "FSx.Client.exceptions.InternalServerError" **Examples** This operation deletes an Amazon FSx file system. response = client.delete_file_system( FileSystemId='fs-0498eed5fe91001ec', ) print(response) Expected Output: { 'FileSystemId': 'fs-0498eed5fe91001ec', 'Lifecycle': 'DELETING', 'ResponseMetadata': { '...': '...', }, } FSx / Client / restore_volume_from_snapshot restore_volume_from_snapshot **************************** FSx.Client.restore_volume_from_snapshot(**kwargs) Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot. See also: AWS API Documentation **Request Syntax** response = client.restore_volume_from_snapshot( ClientRequestToken='string', VolumeId='string', SnapshotId='string', Options=[ 'DELETE_INTERMEDIATE_SNAPSHOTS'|'DELETE_CLONED_VOLUMES', ] ) type ClientRequestToken: string param ClientRequestToken: (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type VolumeId: string param VolumeId: **[REQUIRED]** The ID of the volume that you are restoring. type SnapshotId: string param SnapshotId: **[REQUIRED]** The ID of the source snapshot. Specifies the snapshot that you are restoring from. type Options: list param Options: The settings used when restoring the specified volume from snapshot. * "DELETE_INTERMEDIATE_SNAPSHOTS" - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, "RestoreVolumeFromSnapshot" fails. * "DELETE_CLONED_VOLUMES" - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, "RestoreVolumeFromSnapshot" fails. * *(string) --* rtype: dict returns: **Response Syntax** { 'VolumeId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', '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'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP', 'ProgressPercent': 123, 'RequestTime': datetime(2015, 1, 1), 'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING', 'TargetFileSystemValues': { 'OwnerId': 'string', 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', 'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE', 'FailureDetails': { 'Message': 'string' }, 'StorageCapacity': 123, 'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING', 'VpcId': 'string', 'SubnetIds': [ 'string', ], 'NetworkInterfaceIds': [ 'string', ], 'DNSName': 'string', 'KmsKeyId': 'string', 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'WindowsConfiguration': { 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'RemoteAdministrationEndpoint': 'string', 'PreferredSubnetId': 'string', 'PreferredFileServerIp': 'string', 'ThroughputCapacity': 123, 'MaintenanceOperationsInProgress': [ 'PATCHING'|'BACKING_UP', ], 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ { 'Name': 'string', 'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED' }, ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, 'LustreConfiguration': { 'WeeklyMaintenanceStartTime': 'string', 'DataRepositoryConfiguration': { 'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'FailureDetails': { 'Message': 'string' } }, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'PerUnitStorageThroughput': 123, 'MountName': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'EfaEnabled': True|False, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, 'AdministrativeActions': {'... recursive ...'}, 'OntapConfiguration': { 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'Endpoints': { 'Intercluster': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] }, 'Management': { 'DNSName': 'string', 'IpAddresses': [ 'string', ] } }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'FsxAdminPassword': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, 'FileSystemTypeVersion': 'string', 'OpenZFSConfiguration': { 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeId': 'string', 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'EndpointIpAddress': 'string', 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } }, 'FailureDetails': { 'Message': 'string' }, 'TargetVolumeValues': { 'CreationTime': datetime(2015, 1, 1), 'FileSystemId': 'string', 'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE', 'Name': 'string', 'OntapConfiguration': { 'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE', 'JunctionPath': 'string', 'SecurityStyle': 'UNIX'|'NTFS'|'MIXED', 'SizeInMegabytes': 123, 'StorageEfficiencyEnabled': True|False, 'StorageVirtualMachineId': 'string', 'StorageVirtualMachineRoot': True|False, 'TieringPolicy': { 'CoolingPeriod': 123, 'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE' }, 'UUID': 'string', 'OntapVolumeType': 'RW'|'DP'|'LS', 'SnapshotPolicy': 'string', 'CopyTagsToBackups': True|False, 'SnaplockConfiguration': { 'AuditLogVolume': True|False, 'AutocommitPeriod': { 'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE', 'Value': 123 }, 'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED', 'RetentionPeriod': { 'DefaultRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MinimumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 }, 'MaximumRetention': { 'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED', 'Value': 123 } }, 'SnaplockType': 'COMPLIANCE'|'ENTERPRISE', 'VolumeAppendModeEnabled': True|False }, 'VolumeStyle': 'FLEXVOL'|'FLEXGROUP', 'AggregateConfiguration': { 'Aggregates': [ 'string', ], 'TotalConstituents': 123 }, 'SizeInBytes': 123 }, 'ResourceARN': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeId': 'string', 'VolumeType': 'ONTAP'|'OPENZFS', 'LifecycleTransitionReason': { 'Message': 'string' }, 'AdministrativeActions': {'... recursive ...'}, 'OpenZFSConfiguration': { 'ParentVolumeId': 'string', 'VolumePath': 'string', 'StorageCapacityReservationGiB': 123, 'StorageCapacityQuotaGiB': 123, 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'CopyTagsToSnapshots': True|False, 'OriginSnapshot': { 'SnapshotARN': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' }, 'ReadOnly': True|False, 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'RestoreToSnapshot': 'string', 'DeleteIntermediateSnaphots': True|False, 'DeleteClonedVolumes': True|False, 'DeleteIntermediateData': True|False, 'SourceSnapshotARN': 'string', 'DestinationSnapshot': 'string', 'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY' } }, 'TargetSnapshotValues': { 'ResourceARN': 'string', 'SnapshotId': 'string', 'Name': 'string', 'VolumeId': 'string', 'CreationTime': datetime(2015, 1, 1), 'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE', 'LifecycleTransitionReason': { 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AdministrativeActions': {'... recursive ...'} }, 'TotalTransferBytes': 123, 'RemainingTransferBytes': 123 }, ] } **Response Structure** * *(dict) --* * **VolumeId** *(string) --* The ID of the volume that you restored. * **Lifecycle** *(string) --* The lifecycle state of the volume being restored. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * *(dict) --* Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume. * **AdministrativeActionType** *(string) --* Describes the type of administrative action, as follows: * "FILE_SYSTEM_UPDATE" - A file system update administrative action initiated from the Amazon FSx console, API ( "UpdateFileSystem"), or CLI ( "update-file-system"). * "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 completed successfully, a "STORAGE_OPTIMIZATION" task starts. * For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks. * For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage-optimization progress using the "ProgressPercent" property. When "STORAGE_OPTIMIZATION" has been completed successfully, the parent "FILE_SYSTEM_UPDATE" action status changes to "COMPLETED". For more information, see Managing storage capacity in the *Amazon FSx for Windows File Server User Guide*, Managing storage capacity in the *Amazon FSx for Lustre User Guide*, and Managing storage capacity and provisioned IOPS in the *Amazon FSx for NetApp ONTAP User Guide*. * "FILE_SYSTEM_ALIAS_ASSOCIATION" - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases. * "FILE_SYSTEM_ALIAS_DISASSOCIATION" - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases. * "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 OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateVolume"), or CLI ( "update- volume"). * "VOLUME_RESTORE" - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( "RestoreVolumeFromSnapshot") or CLI ( "restore- volume-from-snapshot"). * "SNAPSHOT_UPDATE" - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( "UpdateSnapshot"), or CLI ( "update-snapshot"). * "RELEASE_NFS_V3_LOCKS" - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. * "DOWNLOAD_DATA_FROM_BACKUP" - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process. * "VOLUME_INITIALIZE_WITH_SNAPSHOT" - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CreateVolume"), or CLI ( "create-volume") when using the using the "FULL_COPY" strategy. * "VOLUME_UPDATE_WITH_SNAPSHOT" - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( "CopySnapshotAndUpdateVolume"), or CLI ( "copy- snapshot-and-update-volume"). * **ProgressPercent** *(integer) --* The percentage-complete status of a "STORAGE_OPTIMIZATION" or "DOWNLOAD_DATA_FROM_BACKUP" administrative action. Does not apply to any other administrative action type. * **RequestTime** *(datetime) --* The time that the administrative action request was received. * **Status** *(string) --* The status of the administrative action, as follows: * "FAILED" - Amazon FSx failed to process the administrative action successfully. * "IN_PROGRESS" - Amazon FSx is processing the administrative action. * "PENDING" - Amazon FSx is waiting to process the administrative action. * "COMPLETED" - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume. * "UPDATED_OPTIMIZING" - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process. * "PENDING" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING. * "IN_PROGRESS" - For a backup restore to a second- generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the "ProgressPercent" element. * **TargetFileSystemValues** *(dict) --* The target value for the administration action, provided in the "UpdateFileSystem" operation. Returned for "FILE_SYSTEM_UPDATE" administrative actions. * **OwnerId** *(string) --* The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. * **CreationTime** *(datetime) --* The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The system-generated, unique 17-digit ID of the file system. * **FileSystemType** *(string) --* The type of Amazon FSx file system, which can be "LUSTRE", "WINDOWS", "ONTAP", or "OPENZFS". * **Lifecycle** *(string) --* The lifecycle status of the file system. The following are the possible values and what they mean: * "AVAILABLE" - The file system is in a healthy state, and is reachable and available for use. * "CREATING" - Amazon FSx is creating the new file system. * "DELETING" - Amazon FSx is deleting an existing file system. * "FAILED" - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. * "MISCONFIGURED" - The file system is in a failed but recoverable state. * "MISCONFIGURED_UNAVAILABLE" - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. * "UPDATING" - The file system is undergoing a customer-initiated update. * **FailureDetails** *(dict) --* A structure providing details of any failures that occurred. * **Message** *(string) --* A message describing any failures that occurred. * **StorageCapacity** *(integer) --* The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "StorageCapacity" is outside of the minimum or maximum values. * **StorageType** *(string) --* The type of storage the file system is using. * If set to "SSD", the file system uses solid state drive storage. * If set to "HDD", the file system uses hard disk drive storage. * If set to "INTELLIGENT_TIERING", the file system uses fully elastic, intelligently-tiered storage. * **VpcId** *(string) --* The ID of the primary virtual private cloud (VPC) for the file system. * **SubnetIds** *(list) --* Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP "MULTI_AZ_1" file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the "PreferredSubnetID" property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For "MULTI_AZ_1" Windows and ONTAP file systems, the file system endpoint is available in the "PreferredSubnetID". * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **NetworkInterfaceIds** *(list) --* The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide.* For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. * *(string) --* An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the *Amazon EC2 User Guide for Linux Instances*. * **DNSName** *(string) --* The Domain Name System (DNS) name for the file system. * **KmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) of the file system resource. * **Tags** *(list) --* The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the *Amazon FSx for Lustre User Guide*. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **WindowsConfiguration** *(dict) --* The configuration for this Amazon FSx for Windows File Server file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **DomainName** *(string) --* The fully qualified domain name of the self- managed AD directory. * **OrganizationalUnitDistinguishedName** *(string) --* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. * **FileSystemAdministratorsGroup** *(string) --* The name of the domain group whose members have administrative privileges for the FSx file system. * **UserName** *(string) --* The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. * **DnsIps** *(list) --* A list of up to three IP addresses of DNS servers or domain controllers in the self- managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. * "SINGLE_AZ_1" - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. * "SINGLE_AZ_2" - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see Single-AZ and Multi-AZ File Systems. * **RemoteAdministrationEndpoint** *(string) --* For "MULTI_AZ_1" deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. * **PreferredSubnetId** *(string) --* For "MULTI_AZ_1" deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in "SubnetIds" property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For "SINGLE_AZ_1" and "SINGLE_AZ_2" deployment types, this value is the same as that for "SubnetIDs". For more information, see Availability and durability: Single-AZ and Multi- AZ file systems. * **PreferredFileServerIp** *(string) --* For "MULTI_AZ_1" deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares. * **ThroughputCapacity** *(integer) --* The throughput of the Amazon FSx file system, measured in megabytes per second. * **MaintenanceOperationsInProgress** *(list) --* The list of maintenance operations in progress for this file system. * *(string) --* An enumeration specifying the currently ongoing maintenance operation. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DailyAutomaticBackupStartTime** *(string) --* The preferred time to take daily automatic backups, in the UTC time zone. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **Aliases** *(list) --* An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases. * *(dict) --* A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the *FSx for Windows File Server User Guide*. * **Name** *(string) --* The name of the DNS alias. The alias name has to meet the following requirements: * Formatted as a fully-qualified domain name (FQDN), "hostname.domain", for example, "accounting.example.com". * Can contain alphanumeric characters, the underscore (_), and the hyphen (-). * Cannot start or end with a hyphen. * Can start with a numeric. For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes. * **Lifecycle** *(string) --* Describes the state of the DNS alias. * AVAILABLE - The DNS alias is associated with an Amazon FSx file system. * CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. * DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. * **AuditLogConfiguration** *(dict) --* The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. * **FileAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file and folder accesses. * "SUCCESS_ONLY" - only successful attempts to access files or folders are logged. * "FAILURE_ONLY" - only failed attempts to access files or folders are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access files or folders are logged. * "DISABLED" - access auditing of files and folders is turned off. * **FileShareAccessAuditLogLevel** *(string) --* Sets which attempt type is logged by Amazon FSx for file share accesses. * "SUCCESS_ONLY" - only successful attempts to access file shares are logged. * "FAILURE_ONLY" - only failed attempts to access file shares are logged. * "SUCCESS_AND_FAILURE" - both successful attempts and failed attempts to access file shares are logged. * "DISABLED" - access auditing of file shares is turned off. * **AuditLogDestination** *(string) --* The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or 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 Firehose delivery stream must begin with the "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. * **DiskIopsConfiguration** *(dict) --* 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. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **LustreConfiguration** *(dict) --* The configuration for the Amazon FSx for Lustre file system. * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, "d" is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. * **DataRepositoryConfiguration** *(dict) --* The data repository configuration object for Lustre file systems returned in the response of the "CreateFileSystem" operation. This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see . * **Lifecycle** *(string) --* Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: * "CREATING" - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. * "AVAILABLE" - The data repository is available for use. * "MISCONFIGURED" - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket. * "UPDATING" - The data repository is undergoing a customer initiated update and availability may be impacted. * "FAILED" - The data repository is in a terminal state that cannot be recovered. * **ImportPath** *(string) --* The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example "s3://import-bucket/optional- prefix". If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. * **ExportPath** *(string) --* The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. * **ImportedFileChunkSize** *(integer) --* For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. * **AutoImportPolicy** *(string) --* Describes the file system's linked S3 data repository's "AutoImportPolicy". The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. "AutoImportPolicy" can have the following values: * "NONE" - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. * "NEW" - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. * "NEW_CHANGED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. * "NEW_CHANGED_DELETED" - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. * **FailureDetails** *(dict) --* Provides detailed information about the data repository if its "Lifecycle" is set to "MISCONFIGURED" or "FAILED". * **Message** *(string) --* A detailed error message. * **DeploymentType** *(string) --* The deployment type of the FSx for Lustre file system. *Scratch deployment type* is designed for temporary storage and shorter-term processing of data. "SCRATCH_1" and "SCRATCH_2" deployment types are best suited for when you need temporary storage and shorter-term processing of data. The "SCRATCH_2" deployment type provides in-transit encryption of data and higher burst throughput capacity than "SCRATCH_1". The "PERSISTENT_1" and "PERSISTENT_2" deployment type is used for longer-term storage and workloads and encryption of data in transit. "PERSISTENT_2" offers higher "PerUnitStorageThroughput" (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see Deployment and storage class options for FSx for Lustre file systems. The default is "SCRATCH_1". * **PerUnitStorageThroughput** *(integer) --* Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for "PERSISTENT_1" and "PERSISTENT_2" deployment types. Valid values: * For "PERSISTENT_1" SSD storage: 50, 100, 200. * For "PERSISTENT_1" HDD storage: 12, 40. * For "PERSISTENT_2" SSD storage: 125, 250, 500, 1000. * **MountName** *(string) --* You use the "MountName" value when mounting the file system. For the "SCRATCH_1" deployment type, this value is always " "fsx"". For "SCRATCH_2", "PERSISTENT_1", and "PERSISTENT_2" deployment types, this value is a string that is unique within an Amazon Web Services Region. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false) * **DriveCacheType** *(string) --* The type of drive cache used by "PERSISTENT_1" file systems that are provisioned with HDD storage devices. This parameter is required when "StorageType" is HDD. When set to "READ" the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when "StorageType" is set to HDD. * **DataCompressionType** *(string) --* The data compression configuration for the file system. "DataCompressionType" can have the following values: * "NONE" - Data compression is turned off for the file system. * "LZ4" - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression. * **LogConfiguration** *(dict) --* The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. * **Level** *(string) --* The data repository events that are logged by Amazon FSx. * "WARN_ONLY" - only warning events are logged. * "ERROR_ONLY" - only error events are logged. * "WARN_ERROR" - both warning events and error events are logged. * "DISABLED" - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of "WARN_ERROR", which can't be changed. * **Destination** *(string) --* The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. * **RootSquashConfiguration** *(dict) --* The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. * **RootSquash** *(string) --* You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format "UID:GID" (for example, "365534:65534"). The UID and GID values can range from "0" to "4294967294": * A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. * A value of "0" (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. * **NoSquashNids** *(list) --* When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: * A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, "10.0.1.6@tcp"). * An address range is described using a dash to separate the range (for example, "10.0.[2-10].[1-255]@tcp"). * *(string) --* * **MetadataConfiguration** *(dict) --* The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a "PERSISTENT_2" deployment type. * **Iops** *(integer) --* The number of Metadata IOPS provisioned for the file system. * For SSD file systems, valid values are "1500", "3000", "6000", "12000", and multiples of "12000" up to a maximum of "192000". * For Intelligent-Tiering file systems, valid values are "6000" and "12000". * **Mode** *(string) --* The metadata configuration mode for provisioning Metadata IOPS for the file system. * In AUTOMATIC mode (supported only on SSD file systems), FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. * In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. * **EfaEnabled** *(boolean) --* Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). * **DataReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent- Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). The SSD read cache size is distributed across provisioned file servers in your file system. Intelligent-Tiering file systems support a minimum of 32 GiB and maximum of 131072 GiB for SSD read cache size for every 4,000 MB/s of throughput capacity provisioned. * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the "UpdateFileSystem" operation. * **OntapConfiguration** *(dict) --* The configuration for this Amazon FSx for NetApp ONTAP file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the FSx for ONTAP file system deployment type in use in the file system. * "MULTI_AZ_1" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. * "MULTI_AZ_2" - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second- generation FSx for ONTAP file system. * "SINGLE_AZ_1" - A file system configured for Single-AZ redundancy. This is a first- generation FSx for ONTAP file system. * "SINGLE_AZ_2" - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second- generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment. * **EndpointIpAddressRange** *(string) --* (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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. * **Endpoints** *(dict) --* The "Management" and "Intercluster" endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. * **Intercluster** *(dict) --* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **Management** *(dict) --* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. * **DNSName** *(string) --* The file system's DNS name. You can mount your file system using its DNS name. * **IpAddresses** *(list) --* IP addresses of the file system endpoint. * *(string) --* * **DiskIopsConfiguration** *(dict) --* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **PreferredSubnetId** *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **ThroughputCapacity** *(integer) --* The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **FsxAdminPassword** *(string) --* You can use the "fsxadmin" user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. * **HAPairs** *(integer) --* Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of "StorageCapacity", "Iops", and "ThroughputCapacity". For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "HAPairs" is less than 1 or greater than 12. * The value of "HAPairs" is greater than 1 and the value of "DeploymentType" is "SINGLE_AZ_1", "MULTI_AZ_1", or "MULTI_AZ_2". * **ThroughputCapacityPerHAPair** *(integer) --* Use to choose the throughput capacity per HA pair. When the value of "HAPairs" is equal to 1, the value of "ThroughputCapacityPerHAPair" is the total throughput for the file system. This field and "ThroughputCapacity" cannot be defined in the same API call, but one is required. This field and "ThroughputCapacity" are the same for file systems with one HA pair. * For "SINGLE_AZ_1" and "MULTI_AZ_1" file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. * For "SINGLE_AZ_2", valid values are 1536, 3072, or 6144 MBps. * For "MULTI_AZ_2", valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The value of "ThroughputCapacity" and "ThroughputCapacityPerHAPair" are not the same value. * The value of deployment type is "SINGLE_AZ_2" and "ThroughputCapacity" / "ThroughputCapacityPerHAPair" is not a valid HA pair (a value between 1 and 12). * The value of "ThroughputCapacityPerHAPair" is not a valid value. * **FileSystemTypeVersion** *(string) --* The Lustre version of the Amazon FSx for Lustre file system, which can be "2.10", "2.12", or "2.15". * **OpenZFSConfiguration** *(dict) --* The configuration for this Amazon FSx for OpenZFS file system. * **AutomaticBackupRetentionDays** *(integer) --* The number of days to retain automatic backups. Setting this property to "0" disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is "30". * **CopyTagsToBackups** *(boolean) --* A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to "true", all tags on the file system are copied to all automatic backups and any user- initiated backups where the user doesn't specify any tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. * **CopyTagsToVolumes** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **DailyAutomaticBackupStartTime** *(string) --* A recurring daily time, in the format "HH:MM". "HH" is the zero-padded hour of the day (0-23), and "MM" is the zero-padded minute of the hour. For example, "05:00" specifies 5 AM daily. * **DeploymentType** *(string) --* Specifies the file-system deployment type. Amazon FSx for OpenZFS supports "MULTI_AZ_1", "SINGLE_AZ_HA_2", "SINGLE_AZ_HA_1", "SINGLE_AZ_2", and "SINGLE_AZ_1". * **ThroughputCapacity** *(integer) --* The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). * **WeeklyMaintenanceStartTime** *(string) --* The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, "1:05:00" specifies maintenance at 5 AM Monday. * **DiskIopsConfiguration** *(dict) --* 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). * **Mode** *(string) --* Specifies whether the file system is using the "AUTOMATIC" setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a "USER_PROVISIONED" value. * **Iops** *(integer) --* The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of "HAPairs" and "StorageCapacity". The minimum value is calculated as "StorageCapacity" * 3 * "HAPairs" (3 IOPS per GB of "StorageCapacity"). The maximum value is calculated as 200,000 * "HAPairs". Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of "Iops" is outside of the minimum or maximum values. * **RootVolumeId** *(string) --* The ID of the root volume of the OpenZFS file system. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. * **EndpointIpAddressRange** *(string) --* (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. * **RouteTableIds** *(list) --* (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. * *(string) --* * **EndpointIpAddress** *(string) --* The IP address of the endpoint that is used to access data or to manage the file system. * **ReadCacheConfiguration** *(dict) --* Required when "StorageType" is set to "INTELLIGENT_TIERING". Specifies the optional provisioned SSD read cache. * **SizingMode** *(string) --* Specifies how the provisioned SSD read cache is sized, as follows: * Set to "NO_CACHE" if you do not want to use an SSD read cache with your Intelligent-Tiering file system. * Set to "USER_PROVISIONED" to specify the exact size of your SSD read cache. * Set to "PROPORTIONAL_TO_THROUGHPUT_CAPACITY" to have your SSD read cache automatically sized based on your throughput capacity. * **SizeGiB** *(integer) --* Required if "SizingMode" is set to "USER_PROVISIONED". Specifies the size of the file system's SSD read cache, in gibibytes (GiB). * **FailureDetails** *(dict) --* Provides information about a failed administrative action. * **Message** *(string) --* Error message providing details about the failed administrative action. * **TargetVolumeValues** *(dict) --* Describes an Amazon FSx volume. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **FileSystemId** *(string) --* The globally unique ID of the file system, assigned by Amazon FSx. * **Lifecycle** *(string) --* The lifecycle status of the volume. * "AVAILABLE" - The volume is fully available for use. * "CREATED" - The volume has been created. * "CREATING" - Amazon FSx is creating the new volume. * "DELETING" - Amazon FSx is deleting an existing volume. * "FAILED" - Amazon FSx was unable to create the volume. * "MISCONFIGURED" - The volume is in a failed but recoverable state. * "PENDING" - Amazon FSx hasn't started creating the volume. * **Name** *(string) --* The name of the volume. * **OntapConfiguration** *(dict) --* The configuration of an Amazon FSx for NetApp ONTAP volume. * **FlexCacheEndpointType** *(string) --* Specifies the FlexCache endpoint type of the volume. Valid values are the following: * "NONE" specifies that the volume doesn't have a FlexCache configuration. "NONE" is the default. * "ORIGIN" specifies that the volume is the origin volume for a FlexCache volume. * "CACHE" specifies that the volume is a FlexCache volume. * **JunctionPath** *(string) --* Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a "JunctionPath" directly below a parent volume junction or on a directory within a volume. A "JunctionPath" for a volume named "vol3" might be "/vol1/vol2/vol3", or "/vol1/dir2/vol3", or even "/dir1/dir2/vol3". * **SecurityStyle** *(string) --* The security style for the volume, which can be "UNIX", "NTFS", or "MIXED". * **SizeInMegabytes** *(integer) --* The configured size of the volume, in megabytes (MBs). * **StorageEfficiencyEnabled** *(boolean) --* The volume's storage efficiency setting. * **StorageVirtualMachineId** *(string) --* The ID of the volume's storage virtual machine. * **StorageVirtualMachineRoot** *(boolean) --* A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to "false". If this value is "true", then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to "false", helps you identify which volumes to delete before you can delete the SVM. * **TieringPolicy** *(dict) --* The volume's "TieringPolicy" setting. * **CoolingPeriod** *(integer) --* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the "AUTO" and "SNAPSHOT_ONLY" tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for "AUTO" and 2 days for "SNAPSHOT_ONLY". * **Name** *(string) --* Specifies the tiering policy used to transition data. Default value is "SNAPSHOT_ONLY". * "SNAPSHOT_ONLY" - moves cold snapshots to the capacity pool storage tier. * "AUTO" - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. * "ALL" - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. * "NONE" - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier. * **UUID** *(string) --* The volume's universally unique identifier (UUID). * **OntapVolumeType** *(string) --* Specifies the type of volume. Valid values are the following: * "RW" specifies a read/write volume. "RW" is the default. * "DP" specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data. * "LS" specifies a load-sharing mirror volume. A load- sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. * **SnapshotPolicy** *(string) --* Specifies the snapshot policy for the volume. There are three built-in snapshot policies: * "default": This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. * "default-1weekly": This policy is the same as the "default" policy except that it only retains one snapshot from the weekly schedule. * "none": This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken. You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide. * **CopyTagsToBackups** *(boolean) --* A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value. * **SnaplockConfiguration** *(dict) --* The SnapLock configuration object for an FSx for ONTAP SnapLock volume. * **AuditLogVolume** *(boolean) --* Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is "false". If you set "AuditLogVolume" to "true", the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes. * **AutocommitPeriod** *(dict) --* The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to "NONE" disables autocommit. The default value is "NONE". * **Value** *(integer) --* Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid: * "Minutes": 5 - 65,535 * "Hours": 1 - 65,535 * "Days": 1 - 3,650 * "Months": 1 - 120 * "Years": 1 - 10 * **PrivilegedDelete** *(string) --* Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even 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. * **RetentionPeriod** *(dict) --* Specifies the retention period of an FSx for ONTAP SnapLock volume. * **DefaultRetention** *(dict) --* The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MinimumRetention** *(dict) --* The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **MaximumRetention** *(dict) --* The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. * **Type** *(string) --* Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to "INFINITE", the files are retained forever. If you set it to "UNSPECIFIED", the files are retained until you set an explicit retention period. * **Value** *(integer) --* Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for "INFINITE" or "UNSPECIFIED". For all other options, the following ranges are valid: * "Seconds": 0 - 65,535 * "Minutes": 0 - 65,535 * "Hours": 0 - 24 * "Days": 0 - 365 * "Months": 0 - 12 * "Years": 0 - 100 * **SnaplockType** *(string) --* Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes: * "COMPLIANCE": Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. * "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. * **VolumeAppendModeEnabled** *(boolean) --* Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is "false". For more information, see Volume-append mode. * **VolumeStyle** *(string) --* Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. * **AggregateConfiguration** *(dict) --* This structure specifies configuration options for a volume’s storage aggregate or aggregates. * **Aggregates** *(list) --* The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: * The strings in the value of "Aggregates" are not are not formatted as "aggrX", where X is a number between 1 and 12. * The value of "Aggregates" contains aggregates that are not present. * One or more of the aggregates supplied are too close to the volume limit to support adding more volumes. * *(string) --* * **TotalConstituents** *(integer) --* The total number of constituents this FlexGroup volume has. Not applicable for FlexVols. * **SizeInBytes** *(integer) --* The configured size of the volume, in bytes. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **VolumeId** *(string) --* The system-generated, unique ID of the volume. * **VolumeType** *(string) --* The type of the volume. * **LifecycleTransitionReason** *(dict) --* The reason why the volume lifecycle status changed. * **Message** *(string) --* A detailed error message. * **AdministrativeActions** *(list) --* A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the "UpdateVolume" action. * **OpenZFSConfiguration** *(dict) --* The configuration of an Amazon FSx for OpenZFS volume. * **ParentVolumeId** *(string) --* The ID of the parent volume. * **VolumePath** *(string) --* The path to the volume from the root volume. For example, "fsx/parentVolume/volume1". * **StorageCapacityReservationGiB** *(integer) --* The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. * **StorageCapacityQuotaGiB** *(integer) --* The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. * **RecordSizeKiB** *(integer) --* The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the *Amazon FSx for OpenZFS User Guide*. * **DataCompressionType** *(string) --* Specifies the method used to compress the data on the volume. The compression type is "NONE" by default. * "NONE" - Doesn't compress the data on the volume. "NONE" is the default. * "ZSTD" - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. * "LZ4" - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds. * **CopyTagsToSnapshots** *(boolean) --* A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to "false". If it's set to "true", all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is "true" and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. * **OriginSnapshot** *(dict) --* The configuration object that specifies the snapshot to use as the origin of the data for the volume. * **SnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **CopyStrategy** *(string) --* The strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **ReadOnly** *(boolean) --* A Boolean value indicating whether the volume is read- only. * **NfsExports** *(list) --* The configuration object for mounting a Network File System (NFS) file system. * *(dict) --* The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. * **ClientConfigurations** *(list) --* A list of configuration objects that contain the client and options for mounting the OpenZFS file system. * *(dict) --* Specifies who can mount an OpenZFS file system and the options available while mounting the file system. * **Clients** *(string) --* A value that specifies who can mount the file system. You can provide a wildcard character ( "*"), an IP address ( "0.0.0.0"), or a CIDR address ( "192.0.2.0/24"). By default, Amazon FSx uses the wildcard character when specifying the client. * **Options** *(list) --* The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following: * "crossmnt" is used by default. If you don't specify "crossmnt" when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory. * "sync" is used by default. If you instead specify "async", the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. * *(string) --* * **UserAndGroupQuotas** *(list) --* An object specifying how much storage users or groups can use on the volume. * *(dict) --* Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide. * **Type** *(string) --* Specifies whether the quota applies to a user or group. * **Id** *(integer) --* The ID of the user or group that the quota applies to. * **StorageCapacityQuotaGiB** *(integer) --* The user or group's storage quota, in gibibytes (GiB). * **RestoreToSnapshot** *(string) --* Specifies the ID of the snapshot to which the volume was restored. * **DeleteIntermediateSnaphots** *(boolean) --* A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot. * **DeleteClonedVolumes** *(boolean) --* A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot. * **DeleteIntermediateData** *(boolean) --* A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot. * **SourceSnapshotARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **DestinationSnapshot** *(string) --* The ID of the snapshot that's being copied or was most recently copied to the destination volume. * **CopyStrategy** *(string) --* Specifies the strategy used when copying data from the snapshot to the new volume. * "CLONE" - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data. * "FULL_COPY" - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system. Note: The "INCREMENTAL_COPY" option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume. * **TargetSnapshotValues** *(dict) --* A snapshot of an Amazon FSx for OpenZFS volume. * **ResourceARN** *(string) --* The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the *Amazon Web Services General Reference*. * **SnapshotId** *(string) --* The ID of the snapshot. * **Name** *(string) --* The name of the snapshot. * **VolumeId** *(string) --* The ID of the volume that the snapshot is of. * **CreationTime** *(datetime) --* The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. * **Lifecycle** *(string) --* The lifecycle status of the snapshot. * "PENDING" - Amazon FSx hasn't started creating the snapshot. * "CREATING" - Amazon FSx is creating the snapshot. * "DELETING" - Amazon FSx is deleting the snapshot. * "AVAILABLE" - The snapshot is fully available. * **LifecycleTransitionReason** *(dict) --* Describes why a resource lifecycle state changed. * **Message** *(string) --* A detailed error message. * **Tags** *(list) --* A list of "Tag" values, with a maximum of 50 elements. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". * **AdministrativeActions** *(list) --* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system. * **TotalTransferBytes** *(integer) --* The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying. * **RemainingTransferBytes** *(integer) --* The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying. **Exceptions** * "FSx.Client.exceptions.BadRequest" * "FSx.Client.exceptions.InternalServerError" * "FSx.Client.exceptions.VolumeNotFound" FSx / Client / create_file_system create_file_system ****************** FSx.Client.create_file_system(**kwargs) Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the "CreateFileSystem" API operation: * Amazon FSx for Lustre * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a "CreateFileSystem" operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same. If a file system with the specified client request token exists and the parameters match, "CreateFileSystem" returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns "IncompatibleParameterError". If a file system with the specified client request token doesn't exist, "CreateFileSystem" does the following: * Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of "CREATING". * Returns the description of the file system in JSON format. Note: The "CreateFileSystem" call returns while the file system's lifecycle state is still "CREATING". You can check the file- system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information. See also: AWS API Documentation **Request Syntax** response = client.create_file_system( ClientRequestToken='string', FileSystemType='WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS', StorageCapacity=123, StorageType='SSD'|'HDD'|'INTELLIGENT_TIERING', SubnetIds=[ 'string', ], SecurityGroupIds=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ], KmsKeyId='string', WindowsConfiguration={ 'ActiveDirectoryId': 'string', 'SelfManagedActiveDirectoryConfiguration': { 'DomainName': 'string', 'OrganizationalUnitDistinguishedName': 'string', 'FileSystemAdministratorsGroup': 'string', 'UserName': 'string', 'Password': 'string', 'DnsIps': [ 'string', ] }, 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2', 'PreferredSubnetId': 'string', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'Aliases': [ 'string', ], 'AuditLogConfiguration': { 'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE', 'AuditLogDestination': 'string' }, 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 } }, LustreConfiguration={ 'WeeklyMaintenanceStartTime': 'string', 'ImportPath': 'string', 'ExportPath': 'string', 'ImportedFileChunkSize': 123, 'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2', 'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED', 'PerUnitStorageThroughput': 123, 'DailyAutomaticBackupStartTime': 'string', 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'DriveCacheType': 'NONE'|'READ', 'DataCompressionType': 'NONE'|'LZ4', 'EfaEnabled': True|False, 'LogConfiguration': { 'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR', 'Destination': 'string' }, 'RootSquashConfiguration': { 'RootSquash': 'string', 'NoSquashNids': [ 'string', ] }, 'MetadataConfiguration': { 'Iops': 123, 'Mode': 'AUTOMATIC'|'USER_PROVISIONED' }, 'ThroughputCapacity': 123, 'DataReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } }, OntapConfiguration={ 'AutomaticBackupRetentionDays': 123, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2', 'EndpointIpAddressRange': 'string', 'FsxAdminPassword': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'PreferredSubnetId': 'string', 'RouteTableIds': [ 'string', ], 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'HAPairs': 123, 'ThroughputCapacityPerHAPair': 123 }, FileSystemTypeVersion='string', OpenZFSConfiguration={ 'AutomaticBackupRetentionDays': 123, 'CopyTagsToBackups': True|False, 'CopyTagsToVolumes': True|False, 'DailyAutomaticBackupStartTime': 'string', 'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1', 'ThroughputCapacity': 123, 'WeeklyMaintenanceStartTime': 'string', 'DiskIopsConfiguration': { 'Mode': 'AUTOMATIC'|'USER_PROVISIONED', 'Iops': 123 }, 'RootVolumeConfiguration': { 'RecordSizeKiB': 123, 'DataCompressionType': 'NONE'|'ZSTD'|'LZ4', 'NfsExports': [ { 'ClientConfigurations': [ { 'Clients': 'string', 'Options': [ 'string', ] }, ] }, ], 'UserAndGroupQuotas': [ { 'Type': 'USER'|'GROUP', 'Id': 123, 'StorageCapacityQuotaGiB': 123 }, ], 'CopyTagsToSnapshots': True|False, 'ReadOnly': True|False }, 'PreferredSubnetId': 'string', 'EndpointIpAddressRange': 'string', 'RouteTableIds': [ 'string', ], 'ReadCacheConfiguration': { 'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY', 'SizeGiB': 123 } } ) type ClientRequestToken: string param ClientRequestToken: A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. This field is autopopulated if not provided. type FileSystemType: string param FileSystemType: **[REQUIRED]** The type of Amazon FSx file system to create. Valid values are "WINDOWS", "LUSTRE", "ONTAP", and "OPENZFS". type StorageCapacity: integer param StorageCapacity: Sets the storage capacity of the file system that you're creating, in gibibytes (GiB). **FSx for Lustre file systems** - The amount of storage capacity that you can configure depends on the value that you set for "StorageType" and the Lustre "DeploymentType", as follows: * For "SCRATCH_2", "PERSISTENT_2", and "PERSISTENT_1" deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. * For "PERSISTENT_1" HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. * For "SCRATCH_1" deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. **FSx for ONTAP file systems** - The amount of storage capacity that you can configure depends on the value of the "HAPairs" property. The minimum value is calculated as 1,024 * "HAPairs" and the maximum is calculated as 524,288 * "HAPairs". **FSx for OpenZFS file systems** - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). **FSx for Windows File Server file systems** - The amount of storage capacity that you can configure depends on the value that you set for "StorageType" as follows: * For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). * For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB). type StorageType: string param StorageType: Sets the storage class for the file system that you're creating. Valid values are "SSD", "HDD", and "INTELLIGENT_TIERING". * Set to "SSD" to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. * Set to "HDD" to use hard disk drive storage, which is supported on "SINGLE_AZ_2" and "MULTI_AZ_1" Windows file system deployment types, and on "PERSISTENT_1" Lustre file system deployment types. * Set to "INTELLIGENT_TIERING" to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type and for Lustre file systems with the Persistent_2 deployment type. Default value is "SSD". For more information, see Storage type options in the *FSx for Windows File Server User Guide*, FSx for Lustre storage classes in the *FSx for Lustre User Guide*, and Working with Intelligent-Tiering in the *Amazon FSx for OpenZFS User Guide*. type SubnetIds: list param SubnetIds: **[REQUIRED]** Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP "MULTI_AZ_1" deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the "WindowsConfiguration > PreferredSubnetID" or "OntapConfiguration > PreferredSubnetID" properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the *Amazon FSx for Windows User Guide* and Availability and durability in the *Amazon FSx for ONTAP User Guide*. For Windows "SINGLE_AZ_1" and "SINGLE_AZ_2" and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone. * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* type SecurityGroupIds: list param SecurityGroupIds: A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system. Warning: You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you. * *(string) --* The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security groups for Linux instances in the *Amazon EC2 User Guide*. type Tags: list param Tags: The tags to apply to the file system that's being created. The key value of the "Name" tag appears in the console as the file system name. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". type KmsKeyId: string param KmsKeyId: Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows: * Amazon FSx for Lustre "PERSISTENT_1" and "PERSISTENT_2" deployment types only. "SCRATCH_1" and "SCRATCH_2" types are encrypted using the Amazon FSx service KMS key for your account. * Amazon FSx for NetApp ONTAP * Amazon FSx for OpenZFS * Amazon FSx for Windows File Server If a "KmsKeyId" isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the *Key Management Service API Reference*. type WindowsConfiguration: dict param WindowsConfiguration: The Microsoft Windows configuration for the file system that's being created. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on- premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs. * **DomainName** *(string) --* **[REQUIRED]** The fully qualified domain name of the self-managed AD directory, such as "corp.example.com". * **OrganizationalUnitDistinguishedName** *(string) --* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is "OU=FSx,DC=yourdomain,DC=corp,DC=com". To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. Warning: Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. * **FileSystemAdministratorsGroup** *(string) --* (Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used. * **UserName** *(string) --* **[REQUIRED]** The user name for the service account on your self- managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in "OrganizationalUnitDistinguishedName", or in the default location of your AD domain. * **Password** *(string) --* **[REQUIRED]** The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. * **DnsIps** *(list) --* **[REQUIRED]** A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type * "SINGLE_AZ_1" - (Default) Choose to deploy a file system that is configured for single AZ redundancy. * "SINGLE_AZ_2" - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type. For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency. * **ThroughputCapacity** *(integer) --* **[REQUIRED]** Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the >>*< PreferredSubnetID" property. Windows "SINGLE_AZ_1" and "SINGLE_AZ_2" file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone. * *(string) --* The ID for a subnet. A *subnet* is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the *Amazon VPC User Guide.* type SecurityGroupIds: list param SecurityGroupIds: A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later "DescribeFileSystem" requests. * *(string) --* The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security groups for Linux instances in the *Amazon EC2 User Guide*. type Tags: list param Tags: The tags to be applied to the file system at file system creation. The key value of the "Name" tag appears in the console as the file system name. * *(dict) --* Specifies a key-value pair for a resource tag. * **Key** *(string) --* **[REQUIRED]** A value that specifies the "TagKey", the name of the tag. Tag keys must be unique for the resource to which they are attached. * **Value** *(string) --* **[REQUIRED]** A value that specifies the "TagValue", the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of "finances : April" and also of "payroll : April". type WindowsConfiguration: dict param WindowsConfiguration: The configuration for this Microsoft Windows file system. * **ActiveDirectoryId** *(string) --* The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created. * **SelfManagedActiveDirectoryConfiguration** *(dict) --* The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on- premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs. * **DomainName** *(string) --* **[REQUIRED]** The fully qualified domain name of the self-managed AD directory, such as "corp.example.com". * **OrganizationalUnitDistinguishedName** *(string) --* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is "OU=FSx,DC=yourdomain,DC=corp,DC=com". To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. Warning: Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating. * **FileSystemAdministratorsGroup** *(string) --* (Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used. * **UserName** *(string) --* **[REQUIRED]** The user name for the service account on your self- managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in "OrganizationalUnitDistinguishedName", or in the default location of your AD domain. * **Password** *(string) --* **[REQUIRED]** The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. * **DnsIps** *(list) --* **[REQUIRED]** A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. * *(string) --* * **DeploymentType** *(string) --* Specifies the file system deployment type, valid values are the following: * "MULTI_AZ_1" - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type * "SINGLE_AZ_1" - (Default) Choose to deploy a file system that is configured for single AZ redundancy. * "SINGLE_AZ_2" - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type. For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems. * **PreferredSubnetId** *(string) --* Required when "DeploymentType" is set to "MULTI_AZ_1". This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency. * **ThroughputCapacity** *(integer) --* **[REQUIRED]** Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the >>*<