2020/11/24 - Amazon FSx - 3 updated api methods
Changes This release adds the capability to increase storage capacity of Amazon FSx for Lustre file systems, providing the flexibility to meet evolving storage needs over time.
{'Backup': {'Lifecycle': {'PENDING'}}}
Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:
a Persistent deployment type
is not linked to a data respository.
For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups .
For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows 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 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
client.create_backup(
FileSystemId='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the file system to back up.
string
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
This field is autopopulated if not provided.
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 action, 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 .
dict
Response Syntax
{
'Backup': {
'BackupId': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING',
'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',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'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'
},
]
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
}
},
]
},
'DirectoryInformation': {
'DomainName': 'string',
'ActiveDirectoryId': 'string'
}
}
}
Response Structure
(dict) --
The response object for the CreateBackup operation.
Backup (dict) --
A description of the backup.
BackupId (string) --
The ID of the backup.
Lifecycle (string) --
The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.
DELETED - Amazon FSx deleted the backup and it is no longer available.
FAILED - Amazon FSx could not complete the backup.
FailureDetails (dict) --
Details explaining any failures that occur when creating a backup.
Message (string) --
A message describing the backup creation failure.
Type (string) --
The type of the file system backup.
ProgressPercent (integer) --
The current percent of progress of an asynchronous task.
CreationTime (datetime) --
The time when a particular backup was created.
KmsKeyId (string) --
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
ResourceARN (string) --
The Amazon Resource Name (ARN) for the backup resource.
Tags (list) --
Tags associated with a particular file system.
(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 .
FileSystem (dict) --
Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
OwnerId (string) --
The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS 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, either LUSTRE or WINDOWS .
Lifecycle (string) --
The lifecycle status of the file system, 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 indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
Specifies the IDs of the subnets that the file system is accessible from. For Windows 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 Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system 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 interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.
KmsKeyId (string) --
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference .
ResourceARN (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 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 Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.
SelfManagedActiveDirectoryConfiguration (dict) --
The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server 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 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 two 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 an 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 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 disassocate the DNS alias from the file system.
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. 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.
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.
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.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
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 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = 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 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
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 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS 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 to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag 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. (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 storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
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 Windows file system that you have initiated using the UpdateFileSystem action.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, 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 completes 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 and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes 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.
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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
TargetFileSystemValues (dict) --
Describes 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.
DirectoryInformation (dict) --
The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
ActiveDirectoryId (string) --
The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.
{'Lifecycle': {'PENDING'}}
Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup will not 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
client.delete_backup(
BackupId='string',
ClientRequestToken='string'
)
string
[REQUIRED]
The ID of the backup you want to delete.
string
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.
This field is autopopulated if not provided.
dict
Response Syntax
{
'BackupId': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING'
}
Response Structure
(dict) --
The response object for DeleteBackup operation.
BackupId (string) --
The ID of the backup deleted.
Lifecycle (string) --
The lifecycle of the backup. Should be DELETED .
{'Backups': {'Lifecycle': {'PENDING'}}}
Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups 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.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups 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 backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
See also: AWS API Documentation
Request Syntax
client.describe_backups(
BackupIds=[
'string',
],
Filters=[
{
'Name': 'file-system-id'|'backup-type'|'file-system-type',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.
(string) --
The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.
list
Filters structure. Supported names are file-system-id and backup-type.
(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.
integer
Maximum number of backups 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.
string
Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.
dict
Response Syntax
{
'Backups': [
{
'BackupId': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING',
'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',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'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'
},
]
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
}
},
]
},
'DirectoryInformation': {
'DomainName': 'string',
'ActiveDirectoryId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Response object for DescribeBackups operation.
Backups (list) --
Any array of backups.
(dict) --
A backup of an Amazon FSx file system. For more information see:
BackupId (string) --
The ID of the backup.
Lifecycle (string) --
The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.
DELETED - Amazon FSx deleted the backup and it is no longer available.
FAILED - Amazon FSx could not complete the backup.
FailureDetails (dict) --
Details explaining any failures that occur when creating a backup.
Message (string) --
A message describing the backup creation failure.
Type (string) --
The type of the file system backup.
ProgressPercent (integer) --
The current percent of progress of an asynchronous task.
CreationTime (datetime) --
The time when a particular backup was created.
KmsKeyId (string) --
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
ResourceARN (string) --
The Amazon Resource Name (ARN) for the backup resource.
Tags (list) --
Tags associated with a particular file system.
(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 .
FileSystem (dict) --
Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
OwnerId (string) --
The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS 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, either LUSTRE or WINDOWS .
Lifecycle (string) --
The lifecycle status of the file system, 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 indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
Specifies the IDs of the subnets that the file system is accessible from. For Windows 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 Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system 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 interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.
KmsKeyId (string) --
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference .
ResourceARN (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 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 Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.
SelfManagedActiveDirectoryConfiguration (dict) --
The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server 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 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 two 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 an 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 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 disassocate the DNS alias from the file system.
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. 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.
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.
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.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
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 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = 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 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
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 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS 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 to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag 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. (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 storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
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 Windows file system that you have initiated using the UpdateFileSystem action.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, 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 completes 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 and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes 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.
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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
TargetFileSystemValues (dict) --
Describes 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.
DirectoryInformation (dict) --
The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
ActiveDirectoryId (string) --
The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.
NextToken (string) --
This is present if there are more backups than returned in the response (String). You can use the NextToken value in the later request to fetch the backups.