@datafire/amazonaws_fsx

Client library for Amazon FSx

Installation and Usage

``bash
npm install --save @datafire/amazonaws_fsx
`
`js
let amazonaws_fsx = require('@datafire/amazonaws_fsx').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});

.then(data => {
console.log(data);
});
`

Description

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

Actions

$3

`js
amazonaws_fsx.AssociateFileSystemAliases({
"FileSystemId": null,
"Aliases": null
}, context)
`

#### Input
* input object
* Aliases required
* items AlternateDNSName
* ClientRequestToken ClientRequestToken
* FileSystemId required

#### Output
* output AssociateFileSystemAliasesResponse

$3

`js
amazonaws_fsx.CancelDataRepositoryTask({
"TaskId": null
}, context)
`

#### Input
* input object
* TaskId required

#### Output
* output CancelDataRepositoryTaskResponse

$3

`js
amazonaws_fsx.CreateBackup({
"FileSystemId": null
}, context)
`

#### Input
* input object
* ClientRequestToken
* FileSystemId required
* Tags
* items Tag

#### Output
* output CreateBackupResponse

$3

`js
amazonaws_fsx.CreateDataRepositoryTask({
"Type": null,
"FileSystemId": "",
"Report": null
}, context)
`

#### Input
* input object
* ClientRequestToken ClientRequestToken
* FileSystemId required FileSystemId
* Paths
* items DataRepositoryTaskPath
* Report required
* Enabled required
* Format
* Path
* Scope
* Tags Tags
* Type required

#### Output
* output CreateDataRepositoryTaskResponse

$3

`js
amazonaws_fsx.CreateFileSystem({
"FileSystemType": null,
"StorageCapacity": null,
"SubnetIds": null
}, context)
`

#### Input
* input object
* ClientRequestToken
* FileSystemType required
* KmsKeyId KmsKeyId
* LustreConfiguration CreateFileSystemLustreConfiguration
* SecurityGroupIds
* items SecurityGroupId
* StorageCapacity required
* StorageType
* SubnetIds required
* items SubnetId
* Tags
* items Tag
* WindowsConfiguration
* ActiveDirectoryId
* Aliases
* items AlternateDNSName
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* PreferredSubnetId
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryConfiguration
* ThroughputCapacity required
* WeeklyMaintenanceStartTime

#### Output
* output CreateFileSystemResponse

$3

`js
amazonaws_fsx.CreateFileSystemFromBackup({
"BackupId": "",
"SubnetIds": null
}, context)
`

#### Input
* input object
* BackupId required BackupId
* ClientRequestToken
* LustreConfiguration CreateFileSystemLustreConfiguration
* SecurityGroupIds
* items SecurityGroupId
* StorageType
* SubnetIds required
* items SubnetId
* Tags
* items Tag
* WindowsConfiguration
* ActiveDirectoryId
* Aliases
* items AlternateDNSName
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* PreferredSubnetId
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryConfiguration
* ThroughputCapacity required
* WeeklyMaintenanceStartTime

#### Output
* output CreateFileSystemFromBackupResponse

$3

`js
amazonaws_fsx.DeleteBackup({
"BackupId": null
}, context)
`

#### Input
* input object
* BackupId required
* ClientRequestToken

#### Output
* output DeleteBackupResponse

$3

`js
amazonaws_fsx.DeleteFileSystem({
"FileSystemId": null
}, context)
`

#### Input
* input object
* ClientRequestToken
* FileSystemId required
* LustreConfiguration DeleteFileSystemLustreConfiguration
* WindowsConfiguration DeleteFileSystemWindowsConfiguration

#### Output
* output DeleteFileSystemResponse

$3

`js
amazonaws_fsx.DescribeBackups({}, context)
`

#### Input
* input object
* MaxResults string
* NextToken string
* BackupIds
* items BackupId
* Filters
* items Filter
* MaxResults
* NextToken

#### Output
* output DescribeBackupsResponse

$3

`js
amazonaws_fsx.DescribeDataRepositoryTasks({}, context)
`

#### Input
* input object
* MaxResults string
* NextToken string
* Filters
* items DataRepositoryTaskFilter
* MaxResults MaxResults
* NextToken NextToken
* TaskIds
* items TaskId

#### Output
* output DescribeDataRepositoryTasksResponse

$3

`js
amazonaws_fsx.DescribeFileSystemAliases({
"FileSystemId": null
}, context)
`

#### Input
* input object
* MaxResults string
* NextToken string
* ClientRequestToken ClientRequestToken
* FileSystemId required
* MaxResults
* NextToken

#### Output
* output DescribeFileSystemAliasesResponse

$3

`js
amazonaws_fsx.DescribeFileSystems({}, context)
`

#### Input
* input object
* MaxResults string
* NextToken string
* FileSystemIds
* items FileSystemId
* MaxResults
* NextToken

#### Output
* output DescribeFileSystemsResponse

$3

`js
amazonaws_fsx.DisassociateFileSystemAliases({
"FileSystemId": null,
"Aliases": null
}, context)
`

#### Input
* input object
* Aliases required
* items AlternateDNSName
* ClientRequestToken ClientRequestToken
* FileSystemId required

#### Output
* output DisassociateFileSystemAliasesResponse

$3

`js
amazonaws_fsx.ListTagsForResource({
"ResourceARN": null
}, context)
`

#### Input
* input object
* MaxResults
* NextToken
* ResourceARN required

#### Output
* output ListTagsForResourceResponse

$3

`js
amazonaws_fsx.TagResource({
"ResourceARN": null,
"Tags": null
}, context)
`

#### Input
* input object
* ResourceARN required
* Tags required
* items Tag

#### Output
* output TagResourceResponse

$3

`js
amazonaws_fsx.UntagResource({
"ResourceARN": null,
"TagKeys": null
}, context)
`

#### Input
* input object
* ResourceARN required
* TagKeys required
* items TagKey

#### Output
* output UntagResourceResponse

$3

`js
amazonaws_fsx.UpdateFileSystem({
"FileSystemId": null
}, context)
`

#### Input
* input object
* ClientRequestToken
* FileSystemId required
* LustreConfiguration UpdateFileSystemLustreConfiguration
* StorageCapacity
* WindowsConfiguration
* AutomaticBackupRetentionDays
* DailyAutomaticBackupStartTime
* SelfManagedActiveDirectoryConfiguration
* DnsIps
* items IpAddress
* Password
* UserName
* ThroughputCapacity
* WeeklyMaintenanceStartTime

#### Output
* output UpdateFileSystemResponse

Definitions

$3


* AWSAccountId string: An AWS account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

$3

* ActiveDirectoryBackupAttributes object: The Microsoft AD attributes of the Amazon FSx for Windows File Server file system.
* ActiveDirectoryId
* DomainName

$3

$3

* ActiveDirectoryFullyQualifiedName string

$3

* AdministrativeAction object: Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
* AdministrativeActionType AdministrativeActionType
* FailureDetails AdministrativeActionFailureDetails
* ProgressPercent
* RequestTime
* Status
* TargetFileSystemValues
* AdministrativeActions
* items AdministrativeAction
* CreationTime
* DNSName
* FailureDetails FileSystemFailureDetails
* FileSystemId
* FileSystemType
* KmsKeyId
* Lifecycle
* LustreConfiguration LustreFileSystemConfiguration
* NetworkInterfaceIds
* items NetworkInterfaceId
* OwnerId
* ResourceARN
* StorageCapacity
* StorageType
* SubnetIds
* items SubnetId
* Tags
* items Tag
* VpcId
* WindowsConfiguration
* ActiveDirectoryId
* Aliases Aliases
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* MaintenanceOperationsInProgress
* items FileSystemMaintenanceOperation
* PreferredFileServerIp
* PreferredSubnetId
* RemoteAdministrationEndpoint
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
* ThroughputCapacity
* WeeklyMaintenanceStartTime

$3

* AdministrativeActionFailureDetails object: Provides information about a failed administrative action.
* Message

$3

* AdministrativeActionType string (values: FILE_SYSTEM_UPDATE, STORAGE_OPTIMIZATION, FILE_SYSTEM_ALIAS_ASSOCIATION, FILE_SYSTEM_ALIAS_DISASSOCIATION):

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 .

$3

* AdministrativeActions array
* items AdministrativeAction

$3

* Alias object: 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.
* Lifecycle
* Name

$3

* AliasLifecycle string (values: AVAILABLE, CREATING, DELETING, CREATE_FAILED, DELETE_FAILED)

$3

* Aliases array: 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.
* items Alias

$3

* AlternateDNSName string

$3

* AlternateDNSNames array
* items AlternateDNSName

$3

* ArchivePath string

$3

* AssociateFileSystemAliasesRequest object: The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
* Aliases required
* items AlternateDNSName
* ClientRequestToken ClientRequestToken
* FileSystemId required

$3

* AssociateFileSystemAliasesResponse object: The system generated response showing the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system. It can take up to 2.5 minutes for the alias status to change from CREATING to AVAILABLE.
* Aliases
* items Alias

$3

* AutoImportPolicyType string (values: NONE, NEW, NEW_CHANGED)

$3

* 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.

$3

* Backup object:

A backup of an Amazon FSx file system. For more information see:

• Working with backups for Windows file systems

• Working with backups for Lustre file systems

* BackupId required
* CreationTime required
* DirectoryInformation
* ActiveDirectoryId
* DomainName
* FailureDetails
* Message
* FileSystem required
* AdministrativeActions
* items AdministrativeAction
* CreationTime
* DNSName
* FailureDetails FileSystemFailureDetails
* FileSystemId
* FileSystemType
* KmsKeyId
* Lifecycle
* LustreConfiguration LustreFileSystemConfiguration
* NetworkInterfaceIds
* items NetworkInterfaceId
* OwnerId
* ResourceARN
* StorageCapacity
* StorageType
* SubnetIds
* items SubnetId
* Tags
* items Tag
* VpcId
* WindowsConfiguration
* ActiveDirectoryId
* Aliases Aliases
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* MaintenanceOperationsInProgress
* items FileSystemMaintenanceOperation
* PreferredFileServerIp
* PreferredSubnetId
* RemoteAdministrationEndpoint
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
* ThroughputCapacity
* WeeklyMaintenanceStartTime
* KmsKeyId
* Lifecycle required
* ProgressPercent ProgressPercent
* ResourceARN
* Tags
* items Tag
* Type required

$3

* BackupFailureDetails object: If backup creation fails, this structure contains the details of that failure.
* Message

$3

* BackupId string: The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.

$3

* BackupIds array: A list of backup IDs.
* items BackupId

$3

$3

* BackupLifecycle string (values: AVAILABLE, CREATING, TRANSFERRING, DELETED, FAILED, PENDING):

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 new user-intiated backup

• TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file system.

• DELETED - Amazon FSx deleted the backup and it is no longer available.

• FAILED - Amazon FSx could not complete the backup.

$3

$3

$3

* BackupType string (values: AUTOMATIC, USER_INITIATED, AWS_BACKUP): The type of the backup.

$3

* Backups array: A list of file system backups.
* items Backup

$3

$3

* CancelDataRepositoryTaskRequest object: Cancels a data repository task.
* TaskId required

$3

* CancelDataRepositoryTaskResponse object
* Lifecycle
* TaskId

$3

* ClientRequestToken string: (Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

$3

* CompletionReport object: 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 required
* Format
* Path
* Scope

$3

* CreateBackupRequest object: The request object for the CreateBackup operation.
* ClientRequestToken
* FileSystemId required
* Tags
* items Tag

$3

* CreateBackupResponse object: The response object for the CreateBackup operation.
* Backup
* BackupId required
* CreationTime required
* DirectoryInformation
* ActiveDirectoryId
* DomainName
* FailureDetails
* Message
* FileSystem required
* AdministrativeActions
* items AdministrativeAction
* CreationTime
* DNSName
* FailureDetails FileSystemFailureDetails
* FileSystemId
* FileSystemType
* KmsKeyId
* Lifecycle
* LustreConfiguration LustreFileSystemConfiguration
* NetworkInterfaceIds
* items NetworkInterfaceId
* OwnerId
* ResourceARN
* StorageCapacity
* StorageType
* SubnetIds
* items SubnetId
* Tags
* items Tag
* VpcId
* WindowsConfiguration
* ActiveDirectoryId
* Aliases Aliases
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* MaintenanceOperationsInProgress
* items FileSystemMaintenanceOperation
* PreferredFileServerIp
* PreferredSubnetId
* RemoteAdministrationEndpoint
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
* ThroughputCapacity
* WeeklyMaintenanceStartTime
* KmsKeyId
* Lifecycle required
* ProgressPercent ProgressPercent
* ResourceARN
* Tags
* items Tag
* Type required

$3

* CreateDataRepositoryTaskRequest object
* ClientRequestToken ClientRequestToken
* FileSystemId required FileSystemId
* Paths
* items DataRepositoryTaskPath
* Report required
* Enabled required
* Format
* Path
* Scope
* Tags Tags
* Type required

$3

* CreateDataRepositoryTaskResponse object
* DataRepositoryTask
* CreationTime required CreationTime
* EndTime
* FailureDetails
* Message ErrorMessage
* FileSystemId required FileSystemId
* Lifecycle required
* Paths
* items DataRepositoryTaskPath
* Report CompletionReport
* ResourceARN ResourceARN
* StartTime
* Status
* FailedCount
* LastUpdatedTime
* SucceededCount
* TotalCount
* Tags Tags
* TaskId required
* Type required

$3

* CreateFileSystemFromBackupRequest object: The request object for the CreateFileSystemFromBackup operation.
* BackupId required BackupId
* ClientRequestToken
* LustreConfiguration CreateFileSystemLustreConfiguration
* SecurityGroupIds
* items SecurityGroupId
* StorageType
* SubnetIds required
* items SubnetId
* Tags
* items Tag
* WindowsConfiguration
* ActiveDirectoryId
* Aliases
* items AlternateDNSName
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* PreferredSubnetId
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryConfiguration
* ThroughputCapacity required
* WeeklyMaintenanceStartTime

$3

* CreateFileSystemFromBackupResponse object: The response object for the CreateFileSystemFromBackup operation.
* FileSystem
* AdministrativeActions
* items AdministrativeAction
* CreationTime
* DNSName
* FailureDetails FileSystemFailureDetails
* FileSystemId
* FileSystemType
* KmsKeyId
* Lifecycle
* LustreConfiguration LustreFileSystemConfiguration
* NetworkInterfaceIds
* items NetworkInterfaceId
* OwnerId
* ResourceARN
* StorageCapacity
* StorageType
* SubnetIds
* items SubnetId
* Tags
* items Tag
* VpcId
* WindowsConfiguration
* ActiveDirectoryId
* Aliases Aliases
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* MaintenanceOperationsInProgress
* items FileSystemMaintenanceOperation
* PreferredFileServerIp
* PreferredSubnetId
* RemoteAdministrationEndpoint
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
* ThroughputCapacity
* WeeklyMaintenanceStartTime

$3

* CreateFileSystemLustreConfiguration object: The Lustre configuration for the file system being created.
* AutoImportPolicy
* AutomaticBackupRetentionDays AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime DailyTime
* DeploymentType
* DriveCacheType
* ExportPath
* ImportPath
* ImportedFileChunkSize
* PerUnitStorageThroughput
* WeeklyMaintenanceStartTime

$3

* CreateFileSystemRequest object: The request object used to create a new Amazon FSx file system.
* ClientRequestToken
* FileSystemType required
* KmsKeyId KmsKeyId
* LustreConfiguration CreateFileSystemLustreConfiguration
* SecurityGroupIds
* items SecurityGroupId
* StorageCapacity required
* StorageType
* SubnetIds required
* items SubnetId
* Tags
* items Tag
* WindowsConfiguration
* ActiveDirectoryId
* Aliases
* items AlternateDNSName
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* PreferredSubnetId
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryConfiguration
* ThroughputCapacity required
* WeeklyMaintenanceStartTime

$3

* CreateFileSystemResponse object: The response object returned after the file system is created.
* FileSystem
* AdministrativeActions
* items AdministrativeAction
* CreationTime
* DNSName
* FailureDetails FileSystemFailureDetails
* FileSystemId
* FileSystemType
* KmsKeyId
* Lifecycle
* LustreConfiguration LustreFileSystemConfiguration
* NetworkInterfaceIds
* items NetworkInterfaceId
* OwnerId
* ResourceARN
* StorageCapacity
* StorageType
* SubnetIds
* items SubnetId
* Tags
* items Tag
* VpcId
* WindowsConfiguration
* ActiveDirectoryId
* Aliases Aliases
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* MaintenanceOperationsInProgress
* items FileSystemMaintenanceOperation
* PreferredFileServerIp
* PreferredSubnetId
* RemoteAdministrationEndpoint
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
* ThroughputCapacity
* WeeklyMaintenanceStartTime

$3

* CreateFileSystemWindowsConfiguration object: The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.
* ActiveDirectoryId
* Aliases
* items AlternateDNSName
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* PreferredSubnetId
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryConfiguration
* ThroughputCapacity required
* WeeklyMaintenanceStartTime

$3

* CreationTime string: The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

$3

* DNSName string: The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

$3

* DailyTime 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.

$3

* DataRepositoryConfiguration object: The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
* AutoImportPolicy
* ExportPath
* FailureDetails DataRepositoryFailureDetails
* ImportPath
* ImportedFileChunkSize
* Lifecycle

$3

* DataRepositoryFailureDetails object: Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED.
* Message ErrorMessage

$3

* DataRepositoryLifecycle string (values: CREATING, AVAILABLE, MISCONFIGURED, UPDATING, DELETING)

$3

* DataRepositoryTask object: A description of the data repository task. You use data repository tasks to perform bulk transfer operations between your Amazon FSx file system and its linked data repository.
* CreationTime required CreationTime
* EndTime
* FailureDetails
* Message ErrorMessage
* FileSystemId required FileSystemId
* Lifecycle required
* Paths
* items DataRepositoryTaskPath
* Report CompletionReport
* ResourceARN ResourceARN
* StartTime
* Status
* FailedCount
* LastUpdatedTime
* SucceededCount
* TotalCount
* Tags Tags
* TaskId required
* Type required

$3

$3

$3

* DataRepositoryTaskFailureDetails object: Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.
* Message ErrorMessage

$3

* DataRepositoryTaskFilter object: (Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the 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
* Values
* items DataRepositoryTaskFilterValue

$3

* DataRepositoryTaskFilterName string (values: file-system-id, task-lifecycle)

$3

* DataRepositoryTaskFilterValue string

$3

* DataRepositoryTaskFilterValues array
* items DataRepositoryTaskFilterValue

$3

* DataRepositoryTaskFilters array
* items DataRepositoryTaskFilter

$3

* DataRepositoryTaskLifecycle string (values: PENDING, EXECUTING, FAILED, SUCCEEDED, CANCELED, CANCELING)

$3

$3

* DataRepositoryTaskPath string

$3

* DataRepositoryTaskPaths array
* items DataRepositoryTaskPath

$3

* DataRepositoryTaskStatus object: Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.
* FailedCount
* LastUpdatedTime
* SucceededCount
* TotalCount

$3

* DataRepositoryTaskType string (values: EXPORT_TO_REPOSITORY)

$3

* DataRepositoryTasks array
* items DataRepositoryTask

$3

* DeleteBackupRequest object: The request object for DeleteBackup operation.
* BackupId required
* ClientRequestToken

$3

* DeleteBackupResponse object: The response object for DeleteBackup operation.
* BackupId
* Lifecycle

$3

* DeleteFileSystemLustreConfiguration object: The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.
* FinalBackupTags
* items Tag
* SkipFinalBackup

$3

* DeleteFileSystemLustreResponse object: The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.
* FinalBackupId
* FinalBackupTags
* items Tag

$3

* DeleteFileSystemRequest object: The request object for DeleteFileSystem operation.
* ClientRequestToken
* FileSystemId required
* LustreConfiguration DeleteFileSystemLustreConfiguration
* WindowsConfiguration DeleteFileSystemWindowsConfiguration

$3

* DeleteFileSystemResponse object: The response object for the DeleteFileSystem operation.
* FileSystemId
* Lifecycle
* LustreResponse DeleteFileSystemLustreResponse
* WindowsResponse DeleteFileSystemWindowsResponse

$3

* DeleteFileSystemWindowsConfiguration object: The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.
* FinalBackupTags
* items Tag
* SkipFinalBackup

$3

* DeleteFileSystemWindowsResponse object: The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.
* FinalBackupId
* FinalBackupTags
* items Tag

$3

* DescribeBackupsRequest object: The request object for DescribeBackups operation.
* BackupIds
* items BackupId
* Filters
* items Filter
* MaxResults
* NextToken

$3

* DescribeBackupsResponse object: Response object for DescribeBackups operation.
* Backups
* items Backup
* NextToken

$3

* DescribeDataRepositoryTasksRequest object
* Filters
* items DataRepositoryTaskFilter
* MaxResults MaxResults
* NextToken NextToken
* TaskIds
* items TaskId

$3

* DescribeDataRepositoryTasksResponse object
* DataRepositoryTasks
* items DataRepositoryTask
* NextToken NextToken

$3

* DescribeFileSystemAliasesRequest object: The request object for DescribeFileSystemAliases operation.
* ClientRequestToken ClientRequestToken
* FileSystemId required
* MaxResults
* NextToken

$3

* DescribeFileSystemAliasesResponse object: The response object for DescribeFileSystemAliases operation.
* Aliases
* items Alias
* NextToken

$3

* DescribeFileSystemsRequest object: The request object for DescribeFileSystems operation.
* FileSystemIds
* items FileSystemId
* MaxResults
* NextToken

$3

* DescribeFileSystemsResponse object: The response object for DescribeFileSystems operation.
* FileSystems
* items FileSystem
* NextToken

$3

* DirectoryId string

$3

* DirectoryPassword string

$3

* DirectoryUserName string

$3

* DisassociateFileSystemAliasesRequest object: The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
* Aliases required
* items AlternateDNSName
* ClientRequestToken ClientRequestToken
* FileSystemId required

$3

* DisassociateFileSystemAliasesResponse object: The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.
* Aliases
* items Alias

$3

* DnsIps array
* items IpAddress

$3

* DriveCacheType string (values: NONE, READ)

$3

* EndTime string

$3

* ErrorMessage string: A detailed error message.

$3

* FailedCount integer

$3

* FileSystem object: A description of a specific Amazon FSx file system.
* AdministrativeActions
* items AdministrativeAction
* CreationTime
* DNSName
* FailureDetails FileSystemFailureDetails
* FileSystemId
* FileSystemType
* KmsKeyId
* Lifecycle
* LustreConfiguration LustreFileSystemConfiguration
* NetworkInterfaceIds
* items NetworkInterfaceId
* OwnerId
* ResourceARN
* StorageCapacity
* StorageType
* SubnetIds
* items SubnetId
* Tags
* items Tag
* VpcId
* WindowsConfiguration
* ActiveDirectoryId
* Aliases Aliases
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* MaintenanceOperationsInProgress
* items FileSystemMaintenanceOperation
* PreferredFileServerIp
* PreferredSubnetId
* RemoteAdministrationEndpoint
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
* ThroughputCapacity
* WeeklyMaintenanceStartTime

$3

* FileSystemAdministratorsGroupName string

$3

* FileSystemFailureDetails object: A structure providing details of any failures that occur when creating the file system has failed.
* Message

$3

* FileSystemId string: The globally unique ID of the file system, assigned by Amazon FSx.

$3

* FileSystemIds array: A list of FileSystemIds.
* items FileSystemId

$3

* FileSystemLifecycle string (values: AVAILABLE, CREATING, FAILED, DELETING, MISCONFIGURED, UPDATING): The lifecycle status of the file system.

$3

* FileSystemMaintenanceOperation string (values: PATCHING, BACKING_UP): An enumeration specifying the currently ongoing maintenance operation.

$3

* FileSystemMaintenanceOperations array: A list of maintenance operations.
* items FileSystemMaintenanceOperation

$3

$3

* FileSystemType string (values: WINDOWS, LUSTRE): The type of file system.

$3

* FileSystems array: A list of file systems.
* items FileSystem

$3

* Filter object: 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
* Values
* items FilterValue

$3

* FilterName string (values: file-system-id, backup-type, file-system-type): The name for a filter.

$3

* FilterValue string: The value for a filter.

$3

* FilterValues array: A list of filter values.
* items FilterValue

$3

* Filters array: A list of Filter elements.
* items Filter

$3

* Flag boolean

$3

$3

$3

$3

$3

$3

$3

* IpAddress string

$3

* 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 Amazon FSx for Lustre PERSISTENT_1 file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The Amazon FSx for Lustre SCRATCH_1 and SCRATCH_2 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.

$3

* LastUpdatedTime string

$3

* ListTagsForResourceRequest object: The request object for ListTagsForResource operation.
* MaxResults
* NextToken
* ResourceARN required

$3

* ListTagsForResourceResponse object: The response object for ListTagsForResource operation.
* NextToken
* Tags
* items Tag

$3

* LustreDeploymentType string (values: SCRATCH_1, SCRATCH_2, PERSISTENT_1)

$3

* LustreFileSystemConfiguration object: The configuration for the Amazon FSx for Lustre file system.
* AutomaticBackupRetentionDays AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime DailyTime
* DataRepositoryConfiguration DataRepositoryConfiguration
* DeploymentType
* DriveCacheType
* MountName
* PerUnitStorageThroughput
* WeeklyMaintenanceStartTime

$3

* LustreFileSystemMountName string

$3

* MaxResults integer: The maximum number of resources to return in the response. This value must be an integer greater than zero.

$3

* Megabytes integer

$3

* MegabytesPerSecond integer: Sustained throughput of an Amazon FSx file system in MBps.

$3

$3

* NetworkInterfaceId 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.

$3

* NetworkInterfaceIds array: A list of network interface IDs.
* items NetworkInterfaceId

$3

* 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.

$3

$3

* OrganizationalUnitDistinguishedName string

$3

* PerUnitStorageThroughput integer

$3

* ProgressPercent integer: The current percent of progress of an asynchronous task.

$3

* ReportFormat string (values: REPORT_CSV_20191124)

$3

* ReportScope string (values: FAILED_FILES_ONLY)

$3

* RequestTime string

$3

* ResourceARN string: The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

$3

$3

$3

* SecurityGroupId 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.

$3

* SecurityGroupIds array: A list of security group IDs.
* items SecurityGroupId

$3

* SelfManagedActiveDirectoryAttributes object: The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.
* DnsIps
* items IpAddress
* DomainName
* FileSystemAdministratorsGroup
* OrganizationalUnitDistinguishedName
* UserName

$3

* SelfManagedActiveDirectoryConfiguration object: The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.
* DnsIps required
* items IpAddress
* DomainName required
* FileSystemAdministratorsGroup
* OrganizationalUnitDistinguishedName
* Password required
* UserName required

$3

* SelfManagedActiveDirectoryConfigurationUpdates object: The configuration that Amazon FSx uses to join the Windows File Server instance to a self-managed Microsoft Active Directory (AD) directory.
* DnsIps
* items IpAddress
* Password
* UserName

$3

$3

* StartTime string

$3

* Status string (values: FAILED, IN_PROGRESS, PENDING, COMPLETED, UPDATED_OPTIMIZING)

$3

* StorageCapacity integer: The storage capacity for your Amazon FSx file system, in gibibytes.

$3

* StorageType string (values: SSD, HDD): The storage type for your Amazon FSx file system.

$3

* SubnetId 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.

$3

* SubnetIds array: A list of subnet IDs. Currently, you can specify only one subnet ID in a call to the CreateFileSystem operation.
* items SubnetId

$3

* SucceededCount integer

$3

* Tag object: Specifies a key-value pair for a resource tag.
* Key required
* Value required

$3

* TagKey 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.

$3

* TagKeys array: A list of TagKey values, with a maximum of 50 elements.
* items TagKey

$3

* TagResourceRequest object: The request object for the TagResource operation.
* ResourceARN required
* Tags required
* items Tag

$3

* TagResourceResponse object: The response object for the TagResource operation.

$3

* TagValue string: A string of 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.

$3

* Tags array: A list of Tag values, with a maximum of 50 elements.
* items Tag

$3

* TaskId string

$3

* TaskIds array
* items TaskId

$3

* TotalCount integer

$3

$3

* UntagResourceRequest object: The request object for UntagResource action.
* ResourceARN required
* TagKeys required
* items TagKey

$3

* UntagResourceResponse object: The response object for UntagResource action.

$3

* UpdateFileSystemLustreConfiguration object: The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.
* AutoImportPolicy
* AutomaticBackupRetentionDays AutomaticBackupRetentionDays
* DailyAutomaticBackupStartTime DailyTime
* WeeklyMaintenanceStartTime

$3

* UpdateFileSystemRequest object: The request object for the UpdateFileSystem operation.
* ClientRequestToken
* FileSystemId required
* LustreConfiguration UpdateFileSystemLustreConfiguration
* StorageCapacity
* WindowsConfiguration
* AutomaticBackupRetentionDays
* DailyAutomaticBackupStartTime
* SelfManagedActiveDirectoryConfiguration
* DnsIps
* items IpAddress
* Password
* UserName
* ThroughputCapacity
* WeeklyMaintenanceStartTime

$3

* UpdateFileSystemResponse object: The response object for the UpdateFileSystem operation.
* FileSystem
* AdministrativeActions
* items AdministrativeAction
* CreationTime
* DNSName
* FailureDetails FileSystemFailureDetails
* FileSystemId
* FileSystemType
* KmsKeyId
* Lifecycle
* LustreConfiguration LustreFileSystemConfiguration
* NetworkInterfaceIds
* items NetworkInterfaceId
* OwnerId
* ResourceARN
* StorageCapacity
* StorageType
* SubnetIds
* items SubnetId
* Tags
* items Tag
* VpcId
* WindowsConfiguration
* ActiveDirectoryId
* Aliases Aliases
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* MaintenanceOperationsInProgress
* items FileSystemMaintenanceOperation
* PreferredFileServerIp
* PreferredSubnetId
* RemoteAdministrationEndpoint
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
* ThroughputCapacity
* WeeklyMaintenanceStartTime

$3

* UpdateFileSystemWindowsConfiguration object: Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.
* AutomaticBackupRetentionDays
* DailyAutomaticBackupStartTime
* SelfManagedActiveDirectoryConfiguration
* DnsIps
* items IpAddress
* Password
* UserName
* ThroughputCapacity
* WeeklyMaintenanceStartTime

$3

* VpcId string: The ID of your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

$3

* WeeklyTime string:

A recurring weekly time, in the format D:HH:MM.

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

$3

* WindowsDeploymentType string (values: MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2)

$3

* WindowsFileSystemConfiguration object`: The configuration for this Microsoft Windows file system.
* ActiveDirectoryId
* Aliases Aliases
* AutomaticBackupRetentionDays
* CopyTagsToBackups
* DailyAutomaticBackupStartTime
* DeploymentType
* MaintenanceOperationsInProgress
* items FileSystemMaintenanceOperation
* PreferredFileServerIp
* PreferredSubnetId
* RemoteAdministrationEndpoint
* SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
* ThroughputCapacity
* WeeklyMaintenanceStartTime