@datafire/amazonaws_fsx
v5.0.0
Published
DataFire integration for Amazon FSx
Downloads
4
Readme
@datafire/amazonaws_fsx
Client library for Amazon FSx
Installation and Usage
npm install --save @datafire/amazonaws_fsx
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
AssociateFileSystemAliases
amazonaws_fsx.AssociateFileSystemAliases({
"FileSystemId": null,
"Aliases": null
}, context)
Input
- input
object
- Aliases required
- items AlternateDNSName
- ClientRequestToken ClientRequestToken
- FileSystemId required
- Aliases required
Output
CancelDataRepositoryTask
amazonaws_fsx.CancelDataRepositoryTask({
"TaskId": null
}, context)
Input
- input
object
- TaskId required
Output
CreateBackup
amazonaws_fsx.CreateBackup({
"FileSystemId": null
}, context)
Input
- input
object
- ClientRequestToken
- FileSystemId required
- Tags
- items Tag
Output
- output CreateBackupResponse
CreateDataRepositoryTask
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
CreateFileSystem
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
CreateFileSystemFromBackup
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
DeleteBackup
amazonaws_fsx.DeleteBackup({
"BackupId": null
}, context)
Input
- input
object
- BackupId required
- ClientRequestToken
Output
- output DeleteBackupResponse
DeleteFileSystem
amazonaws_fsx.DeleteFileSystem({
"FileSystemId": null
}, context)
Input
- input
object
- ClientRequestToken
- FileSystemId required
- LustreConfiguration DeleteFileSystemLustreConfiguration
- WindowsConfiguration DeleteFileSystemWindowsConfiguration
Output
- output DeleteFileSystemResponse
DescribeBackups
amazonaws_fsx.DescribeBackups({}, context)
Input
- input
object
Output
- output DescribeBackupsResponse
DescribeDataRepositoryTasks
amazonaws_fsx.DescribeDataRepositoryTasks({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- Filters
- items DataRepositoryTaskFilter
- MaxResults MaxResults
- NextToken NextToken
- TaskIds
- items TaskId
- MaxResults
Output
DescribeFileSystemAliases
amazonaws_fsx.DescribeFileSystemAliases({
"FileSystemId": null
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- ClientRequestToken ClientRequestToken
- FileSystemId required
- MaxResults
- NextToken
- MaxResults
Output
DescribeFileSystems
amazonaws_fsx.DescribeFileSystems({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- FileSystemIds
- items FileSystemId
- MaxResults
- NextToken
- MaxResults
Output
- output DescribeFileSystemsResponse
DisassociateFileSystemAliases
amazonaws_fsx.DisassociateFileSystemAliases({
"FileSystemId": null,
"Aliases": null
}, context)
Input
- input
object
- Aliases required
- items AlternateDNSName
- ClientRequestToken ClientRequestToken
- FileSystemId required
- Aliases required
Output
ListTagsForResource
amazonaws_fsx.ListTagsForResource({
"ResourceARN": null
}, context)
Input
- input
object
- MaxResults
- NextToken
- ResourceARN required
Output
- output ListTagsForResourceResponse
TagResource
amazonaws_fsx.TagResource({
"ResourceARN": null,
"Tags": null
}, context)
Input
- input
object
- ResourceARN required
- Tags required
- items Tag
Output
- output TagResourceResponse
UntagResource
amazonaws_fsx.UntagResource({
"ResourceARN": null,
"TagKeys": null
}, context)
Input
- input
object
- ResourceARN required
- TagKeys required
- items TagKey
Output
- output UntagResourceResponse
UpdateFileSystem
amazonaws_fsx.UpdateFileSystem({
"FileSystemId": null
}, context)
Input
- input
object
- ClientRequestToken
- FileSystemId required
- LustreConfiguration UpdateFileSystemLustreConfiguration
- StorageCapacity
- WindowsConfiguration
- AutomaticBackupRetentionDays
- DailyAutomaticBackupStartTime
- SelfManagedActiveDirectoryConfiguration
- DnsIps
- items IpAddress
- Password
- UserName
- DnsIps
- ThroughputCapacity
- WeeklyMaintenanceStartTime
Output
- output UpdateFileSystemResponse
Definitions
AWSAccountId
- AWSAccountId
string
: An AWS account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
ActiveDirectoryBackupAttributes
- ActiveDirectoryBackupAttributes
object
: The Microsoft AD attributes of the Amazon FSx for Windows File Server file system.- ActiveDirectoryId
- DomainName
ActiveDirectoryError
ActiveDirectoryFullyQualifiedName
- ActiveDirectoryFullyQualifiedName
string
AdministrativeAction
- 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
- PreferredFileServerIp
- PreferredSubnetId
- RemoteAdministrationEndpoint
- SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
- ThroughputCapacity
- WeeklyMaintenanceStartTime
- AdministrativeActions
AdministrativeActionFailureDetails
- AdministrativeActionFailureDetails
object
: Provides information about a failed administrative action.- Message
AdministrativeActionType
- 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 .
AdministrativeActions
- AdministrativeActions
array
- items AdministrativeAction
Alias
- 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
AliasLifecycle
- AliasLifecycle
string
(values: AVAILABLE, CREATING, DELETING, CREATE_FAILED, DELETE_FAILED)
Aliases
- 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
AlternateDNSName
- AlternateDNSName
string
AlternateDNSNames
- AlternateDNSNames
array
- items AlternateDNSName
ArchivePath
- ArchivePath
string
AssociateFileSystemAliasesRequest
- 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
- Aliases required
AssociateFileSystemAliasesResponse
- 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
- Aliases
AutoImportPolicyType
- AutoImportPolicyType
string
(values: NONE, NEW, NEW_CHANGED)
AutomaticBackupRetentionDays
- 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.
Backup
- 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
- PreferredFileServerIp
- PreferredSubnetId
- RemoteAdministrationEndpoint
- SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
- ThroughputCapacity
- WeeklyMaintenanceStartTime
- AdministrativeActions
- KmsKeyId
- Lifecycle required
- ProgressPercent ProgressPercent
- ResourceARN
- Tags
- items Tag
- Type required
BackupFailureDetails
- BackupFailureDetails
object
: If backup creation fails, this structure contains the details of that failure.- Message
BackupId
- BackupId
string
: The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.
BackupIds
- BackupIds
array
: A list of backup IDs.- items BackupId
BackupInProgress
BackupLifecycle
- 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.
BackupNotFound
BackupRestoring
BackupType
- BackupType
string
(values: AUTOMATIC, USER_INITIATED, AWS_BACKUP): The type of the backup.
Backups
- Backups
array
: A list of file system backups.- items Backup
BadRequest
CancelDataRepositoryTaskRequest
- CancelDataRepositoryTaskRequest
object
: Cancels a data repository task.- TaskId required
CancelDataRepositoryTaskResponse
- CancelDataRepositoryTaskResponse
object
- Lifecycle
- TaskId
ClientRequestToken
- 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.
CompletionReport
- 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
CreateBackupRequest
- CreateBackupRequest
object
: The request object for the CreateBackup operation.- ClientRequestToken
- FileSystemId required
- Tags
- items Tag
CreateBackupResponse
- 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
- PreferredFileServerIp
- PreferredSubnetId
- RemoteAdministrationEndpoint
- SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
- ThroughputCapacity
- WeeklyMaintenanceStartTime
- AdministrativeActions
- KmsKeyId
- Lifecycle required
- ProgressPercent ProgressPercent
- ResourceARN
- Tags
- items Tag
- Type required
- Backup
CreateDataRepositoryTaskRequest
- CreateDataRepositoryTaskRequest
object
- ClientRequestToken ClientRequestToken
- FileSystemId required FileSystemId
- Paths
- items DataRepositoryTaskPath
- Report required
- Enabled required
- Format
- Path
- Scope
- Tags Tags
- Type required
CreateDataRepositoryTaskResponse
- 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
- DataRepositoryTask
CreateFileSystemFromBackupRequest
- 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
CreateFileSystemFromBackupResponse
- 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
- PreferredFileServerIp
- PreferredSubnetId
- RemoteAdministrationEndpoint
- SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
- ThroughputCapacity
- WeeklyMaintenanceStartTime
- AdministrativeActions
- FileSystem
CreateFileSystemLustreConfiguration
- CreateFileSystemLustreConfiguration
object
: The Lustre configuration for the file system being created.- AutoImportPolicy
- AutomaticBackupRetentionDays AutomaticBackupRetentionDays
- CopyTagsToBackups
- DailyAutomaticBackupStartTime DailyTime
- DeploymentType
- DriveCacheType
- ExportPath
- ImportPath
- ImportedFileChunkSize
- PerUnitStorageThroughput
- WeeklyMaintenanceStartTime
CreateFileSystemRequest
- 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
CreateFileSystemResponse
- 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
- PreferredFileServerIp
- PreferredSubnetId
- RemoteAdministrationEndpoint
- SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
- ThroughputCapacity
- WeeklyMaintenanceStartTime
- AdministrativeActions
- FileSystem
CreateFileSystemWindowsConfiguration
- 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
CreationTime
- CreationTime
string
: The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
DNSName
- DNSName
string
: The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
DailyTime
- 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.
DataRepositoryConfiguration
- 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
DataRepositoryFailureDetails
- DataRepositoryFailureDetails
object
: Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED.- Message ErrorMessage
DataRepositoryLifecycle
- DataRepositoryLifecycle
string
(values: CREATING, AVAILABLE, MISCONFIGURED, UPDATING, DELETING)
DataRepositoryTask
- 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
DataRepositoryTaskEnded
DataRepositoryTaskExecuting
DataRepositoryTaskFailureDetails
- DataRepositoryTaskFailureDetails
object
: Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.- Message ErrorMessage
DataRepositoryTaskFilter
- 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
DataRepositoryTaskFilterName
- DataRepositoryTaskFilterName
string
(values: file-system-id, task-lifecycle)
DataRepositoryTaskFilterValue
- DataRepositoryTaskFilterValue
string
DataRepositoryTaskFilterValues
- DataRepositoryTaskFilterValues
array
DataRepositoryTaskFilters
- DataRepositoryTaskFilters
array
- items DataRepositoryTaskFilter
DataRepositoryTaskLifecycle
- DataRepositoryTaskLifecycle
string
(values: PENDING, EXECUTING, FAILED, SUCCEEDED, CANCELED, CANCELING)
DataRepositoryTaskNotFound
DataRepositoryTaskPath
- DataRepositoryTaskPath
string
DataRepositoryTaskPaths
- DataRepositoryTaskPaths
array
- items DataRepositoryTaskPath
DataRepositoryTaskStatus
- 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
DataRepositoryTaskType
- DataRepositoryTaskType
string
(values: EXPORT_TO_REPOSITORY)
DataRepositoryTasks
- DataRepositoryTasks
array
- items DataRepositoryTask
DeleteBackupRequest
- DeleteBackupRequest
object
: The request object for DeleteBackup operation.- BackupId required
- ClientRequestToken
DeleteBackupResponse
- DeleteBackupResponse
object
: The response object for DeleteBackup operation.- BackupId
- Lifecycle
DeleteFileSystemLustreConfiguration
- DeleteFileSystemLustreConfiguration
object
: The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.- FinalBackupTags
- items Tag
- SkipFinalBackup
- FinalBackupTags
DeleteFileSystemLustreResponse
- DeleteFileSystemLustreResponse
object
: The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.- FinalBackupId
- FinalBackupTags
- items Tag
DeleteFileSystemRequest
- DeleteFileSystemRequest
object
: The request object for DeleteFileSystem operation.- ClientRequestToken
- FileSystemId required
- LustreConfiguration DeleteFileSystemLustreConfiguration
- WindowsConfiguration DeleteFileSystemWindowsConfiguration
DeleteFileSystemResponse
- DeleteFileSystemResponse
object
: The response object for the DeleteFileSystem operation.- FileSystemId
- Lifecycle
- LustreResponse DeleteFileSystemLustreResponse
- WindowsResponse DeleteFileSystemWindowsResponse
DeleteFileSystemWindowsConfiguration
- DeleteFileSystemWindowsConfiguration
object
: The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.- FinalBackupTags
- items Tag
- SkipFinalBackup
- FinalBackupTags
DeleteFileSystemWindowsResponse
- DeleteFileSystemWindowsResponse
object
: The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.- FinalBackupId
- FinalBackupTags
- items Tag
DescribeBackupsRequest
- DescribeBackupsRequest
object
: The request object for DescribeBackups operation.
DescribeBackupsResponse
- DescribeBackupsResponse
object
: Response object for DescribeBackups operation.- Backups
- items Backup
- NextToken
- Backups
DescribeDataRepositoryTasksRequest
- DescribeDataRepositoryTasksRequest
object
- Filters
- items DataRepositoryTaskFilter
- MaxResults MaxResults
- NextToken NextToken
- TaskIds
- items TaskId
- Filters
DescribeDataRepositoryTasksResponse
- DescribeDataRepositoryTasksResponse
object
- DataRepositoryTasks
- items DataRepositoryTask
- NextToken NextToken
- DataRepositoryTasks
DescribeFileSystemAliasesRequest
- DescribeFileSystemAliasesRequest
object
: The request object for DescribeFileSystemAliases operation.- ClientRequestToken ClientRequestToken
- FileSystemId required
- MaxResults
- NextToken
DescribeFileSystemAliasesResponse
- DescribeFileSystemAliasesResponse
object
: The response object for DescribeFileSystemAliases operation.- Aliases
- items Alias
- NextToken
- Aliases
DescribeFileSystemsRequest
- DescribeFileSystemsRequest
object
: The request object for DescribeFileSystems operation.- FileSystemIds
- items FileSystemId
- MaxResults
- NextToken
- FileSystemIds
DescribeFileSystemsResponse
- DescribeFileSystemsResponse
object
: The response object for DescribeFileSystems operation.- FileSystems
- items FileSystem
- NextToken
- FileSystems
DirectoryId
- DirectoryId
string
DirectoryPassword
- DirectoryPassword
string
DirectoryUserName
- DirectoryUserName
string
DisassociateFileSystemAliasesRequest
- 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
- Aliases required
DisassociateFileSystemAliasesResponse
- 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
- Aliases
DnsIps
- DnsIps
array
- items IpAddress
DriveCacheType
- DriveCacheType
string
(values: NONE, READ)
EndTime
- EndTime
string
ErrorMessage
- ErrorMessage
string
: A detailed error message.
FailedCount
- FailedCount
integer
FileSystem
- 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
- PreferredFileServerIp
- PreferredSubnetId
- RemoteAdministrationEndpoint
- SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
- ThroughputCapacity
- WeeklyMaintenanceStartTime
- AdministrativeActions
FileSystemAdministratorsGroupName
- FileSystemAdministratorsGroupName
string
FileSystemFailureDetails
- FileSystemFailureDetails
object
: A structure providing details of any failures that occur when creating the file system has failed.- Message
FileSystemId
- FileSystemId
string
: The globally unique ID of the file system, assigned by Amazon FSx.
FileSystemIds
- FileSystemIds
array
: A list of FileSystemIds.- items FileSystemId
FileSystemLifecycle
- FileSystemLifecycle
string
(values: AVAILABLE, CREATING, FAILED, DELETING, MISCONFIGURED, UPDATING): The lifecycle status of the file system.
FileSystemMaintenanceOperation
- FileSystemMaintenanceOperation
string
(values: PATCHING, BACKING_UP): An enumeration specifying the currently ongoing maintenance operation.
FileSystemMaintenanceOperations
- FileSystemMaintenanceOperations
array
: A list of maintenance operations.
FileSystemNotFound
FileSystemType
- FileSystemType
string
(values: WINDOWS, LUSTRE): The type of file system.
FileSystems
- FileSystems
array
: A list of file systems.- items FileSystem
Filter
- 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
FilterName
- FilterName
string
(values: file-system-id, backup-type, file-system-type): The name for a filter.
FilterValue
- FilterValue
string
: The value for a filter.
FilterValues
- FilterValues
array
: A list of filter values.- items FilterValue
Filters
- Filters
array
: A list of Filter elements.- items Filter
Flag
- Flag
boolean
IncompatibleParameterError
InternalServerError
InvalidExportPath
InvalidImportPath
InvalidNetworkSettings
InvalidPerUnitStorageThroughput
IpAddress
- IpAddress
string
KmsKeyId
- 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.
LastUpdatedTime
- LastUpdatedTime
string
ListTagsForResourceRequest
- ListTagsForResourceRequest
object
: The request object for ListTagsForResource operation.- MaxResults
- NextToken
- ResourceARN required
ListTagsForResourceResponse
- ListTagsForResourceResponse
object
: The response object for ListTagsForResource operation.- NextToken
- Tags
- items Tag
LustreDeploymentType
- LustreDeploymentType
string
(values: SCRATCH_1, SCRATCH_2, PERSISTENT_1)
LustreFileSystemConfiguration
- LustreFileSystemConfiguration
object
: The configuration for the Amazon FSx for Lustre file system.- AutomaticBackupRetentionDays AutomaticBackupRetentionDays
- CopyTagsToBackups
- DailyAutomaticBackupStartTime DailyTime
- DataRepositoryConfiguration DataRepositoryConfiguration
- DeploymentType
- DriveCacheType
- MountName
- PerUnitStorageThroughput
- WeeklyMaintenanceStartTime
LustreFileSystemMountName
- LustreFileSystemMountName
string
MaxResults
- MaxResults
integer
: The maximum number of resources to return in the response. This value must be an integer greater than zero.
Megabytes
- Megabytes
integer
MegabytesPerSecond
- MegabytesPerSecond
integer
: Sustained throughput of an Amazon FSx file system in MBps.
MissingFileSystemConfiguration
NetworkInterfaceId
- 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.
NetworkInterfaceIds
- NetworkInterfaceIds
array
: A list of network interface IDs.- items NetworkInterfaceId
NextToken
- 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.
NotServiceResourceError
OrganizationalUnitDistinguishedName
- OrganizationalUnitDistinguishedName
string
PerUnitStorageThroughput
- PerUnitStorageThroughput
integer
ProgressPercent
- ProgressPercent
integer
: The current percent of progress of an asynchronous task.
ReportFormat
- ReportFormat
string
(values: REPORT_CSV_20191124)
ReportScope
- ReportScope
string
(values: FAILED_FILES_ONLY)
RequestTime
- RequestTime
string
ResourceARN
- 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.
ResourceDoesNotSupportTagging
ResourceNotFound
SecurityGroupId
- 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.
SecurityGroupIds
- SecurityGroupIds
array
: A list of security group IDs.- items SecurityGroupId
SelfManagedActiveDirectoryAttributes
- 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
- DnsIps
SelfManagedActiveDirectoryConfiguration
- 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
- DnsIps required
SelfManagedActiveDirectoryConfigurationUpdates
- 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
- DnsIps
ServiceLimitExceeded
StartTime
- StartTime
string
Status
- Status
string
(values: FAILED, IN_PROGRESS, PENDING, COMPLETED, UPDATED_OPTIMIZING)
StorageCapacity
- StorageCapacity
integer
: The storage capacity for your Amazon FSx file system, in gibibytes.
StorageType
- StorageType
string
(values: SSD, HDD): The storage type for your Amazon FSx file system.
SubnetId
- 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.
SubnetIds
- SubnetIds
array
: A list of subnet IDs. Currently, you can specify only one subnet ID in a call to the CreateFileSystem operation.- items SubnetId
SucceededCount
- SucceededCount
integer
Tag
- Tag
object
: Specifies a key-value pair for a resource tag.- Key required
- Value required
TagKey
- 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.
TagKeys
- TagKeys
array
: A list of TagKey values, with a maximum of 50 elements.- items TagKey
TagResourceRequest
- TagResourceRequest
object
: The request object for the TagResource operation.- ResourceARN required
- Tags required
- items Tag
TagResourceResponse
- TagResourceResponse
object
: The response object for the TagResource operation.
TagValue
- 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.
Tags
- Tags
array
: A list of Tag values, with a maximum of 50 elements.- items Tag
TaskId
- TaskId
string
TaskIds
- TaskIds
array
- items TaskId
TotalCount
- TotalCount
integer
UnsupportedOperation
UntagResourceRequest
- UntagResourceRequest
object
: The request object for UntagResource action.- ResourceARN required
- TagKeys required
- items TagKey
UntagResourceResponse
- UntagResourceResponse
object
: The response object for UntagResource action.
UpdateFileSystemLustreConfiguration
- UpdateFileSystemLustreConfiguration
object
: The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.- AutoImportPolicy
- AutomaticBackupRetentionDays AutomaticBackupRetentionDays
- DailyAutomaticBackupStartTime DailyTime
- WeeklyMaintenanceStartTime
UpdateFileSystemRequest
- UpdateFileSystemRequest
object
: The request object for the UpdateFileSystem operation.- ClientRequestToken
- FileSystemId required
- LustreConfiguration UpdateFileSystemLustreConfiguration
- StorageCapacity
- WindowsConfiguration
- AutomaticBackupRetentionDays
- DailyAutomaticBackupStartTime
- SelfManagedActiveDirectoryConfiguration
- DnsIps
- items IpAddress
- Password
- UserName
- DnsIps
- ThroughputCapacity
- WeeklyMaintenanceStartTime
UpdateFileSystemResponse
- 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
- PreferredFileServerIp
- PreferredSubnetId
- RemoteAdministrationEndpoint
- SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
- ThroughputCapacity
- WeeklyMaintenanceStartTime
- AdministrativeActions
- FileSystem
UpdateFileSystemWindowsConfiguration
- 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
- DnsIps
- ThroughputCapacity
- WeeklyMaintenanceStartTime
VpcId
- VpcId
string
: The ID of your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
WeeklyTime
- 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.
WindowsDeploymentType
- WindowsDeploymentType
string
(values: MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2)
WindowsFileSystemConfiguration
- WindowsFileSystemConfiguration
object
: The configuration for this Microsoft Windows file system.- ActiveDirectoryId
- Aliases Aliases
- AutomaticBackupRetentionDays
- CopyTagsToBackups
- DailyAutomaticBackupStartTime
- DeploymentType
- MaintenanceOperationsInProgress
- PreferredFileServerIp
- PreferredSubnetId
- RemoteAdministrationEndpoint
- SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
- ThroughputCapacity
- WeeklyMaintenanceStartTime