Nothing
# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common get_config new_operation new_request send_request
#' @include fsx_service.R
NULL
#' Use this action to associate one or more Domain Name Server (DNS)
#' aliases with an existing Amazon FSx for Windows File Server file system
#'
#' @description
#' Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see [Working with DNS Aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) and [Walkthrough 5: Using DNS aliases to access your file system](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/supported-fsx-clients.html#dns-aliases), including additional steps you must take to be able to access your file system using a DNS alias.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_associate_file_system_aliases/](https://www.paws-r-sdk.com/docs/fsx_associate_file_system_aliases/) for full documentation.
#'
#' @param ClientRequestToken
#' @param FileSystemId [required] Specifies the file system with which you want to associate one or more
#' DNS aliases.
#' @param Aliases [required] An array of one or more DNS alias names to associate with the file
#' system. The alias name has to comply with the following formatting
#' requirements:
#'
#' - Formatted as a fully-qualified domain name (FQDN), *hostname.domain*
#' , for example, `accounting.corp.example.com`.
#'
#' - Can contain alphanumeric characters and the hyphen (-).
#'
#' - Cannot start or end with a hyphen.
#'
#' - Can start with a numeric.
#'
#' For DNS alias 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.
#'
#' @keywords internal
#'
#' @rdname fsx_associate_file_system_aliases
fsx_associate_file_system_aliases <- function(ClientRequestToken = NULL, FileSystemId, Aliases) {
op <- new_operation(
name = "AssociateFileSystemAliases",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$associate_file_system_aliases_input(ClientRequestToken = ClientRequestToken, FileSystemId = FileSystemId, Aliases = Aliases)
output <- .fsx$associate_file_system_aliases_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$associate_file_system_aliases <- fsx_associate_file_system_aliases
#' Cancels an existing Amazon FSx for Lustre data repository task if that
#' task is in either the PENDING or EXECUTING state
#'
#' @description
#' Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the `PENDING` or `EXECUTING` state. When you cancel am export task, Amazon FSx does the following.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_cancel_data_repository_task/](https://www.paws-r-sdk.com/docs/fsx_cancel_data_repository_task/) for full documentation.
#'
#' @param TaskId [required] Specifies the data repository task to cancel.
#'
#' @keywords internal
#'
#' @rdname fsx_cancel_data_repository_task
fsx_cancel_data_repository_task <- function(TaskId) {
op <- new_operation(
name = "CancelDataRepositoryTask",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$cancel_data_repository_task_input(TaskId = TaskId)
output <- .fsx$cancel_data_repository_task_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$cancel_data_repository_task <- fsx_cancel_data_repository_task
#' Copies an existing backup within the same Amazon Web Services account to
#' another Amazon Web Services Region (cross-Region copy) or within the
#' same Amazon Web Services Region (in-Region copy)
#'
#' @description
#' Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_copy_backup/](https://www.paws-r-sdk.com/docs/fsx_copy_backup/) for full documentation.
#'
#' @param ClientRequestToken
#' @param SourceBackupId [required] The ID of the source backup. Specifies the ID of the backup that's being
#' copied.
#' @param SourceRegion The source Amazon Web Services Region of the backup. Specifies the
#' Amazon Web Services Region from which the backup is being copied. The
#' source and destination Regions must be in the same Amazon Web Services
#' partition. If you don't specify a Region, `SourceRegion` defaults to the
#' Region where the request is sent from (in-Region copy).
#' @param KmsKeyId
#' @param CopyTags A Boolean flag indicating whether tags from the source backup should be
#' copied to the backup copy. This value defaults to `false`.
#'
#' If you set `CopyTags` to `true` and the source backup has existing tags,
#' you can use the `Tags` parameter to create new tags, provided that the
#' sum of the source backup tags and the new tags doesn't exceed 50. Both
#' sets of tags are merged. If there are tag conflicts (for example, two
#' tags with the same key but different values), the tags created with the
#' `Tags` parameter take precedence.
#' @param Tags
#'
#' @keywords internal
#'
#' @rdname fsx_copy_backup
fsx_copy_backup <- function(ClientRequestToken = NULL, SourceBackupId, SourceRegion = NULL, KmsKeyId = NULL, CopyTags = NULL, Tags = NULL) {
op <- new_operation(
name = "CopyBackup",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$copy_backup_input(ClientRequestToken = ClientRequestToken, SourceBackupId = SourceBackupId, SourceRegion = SourceRegion, KmsKeyId = KmsKeyId, CopyTags = CopyTags, Tags = Tags)
output <- .fsx$copy_backup_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$copy_backup <- fsx_copy_backup
#' Updates an existing volume by using a snapshot from another Amazon FSx
#' for OpenZFS file system
#'
#' @description
#' Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see [on-demand data replication](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/on-demand-replication.html) in the Amazon FSx for OpenZFS User Guide.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_copy_snapshot_and_update_volume/](https://www.paws-r-sdk.com/docs/fsx_copy_snapshot_and_update_volume/) for full documentation.
#'
#' @param ClientRequestToken
#' @param VolumeId [required] Specifies the ID of the volume that you are copying the snapshot to.
#' @param SourceSnapshotARN [required]
#' @param CopyStrategy Specifies the strategy to use when copying data from a snapshot to the
#' volume.
#'
#' - `FULL_COPY` - Copies all data from the snapshot to the volume.
#'
#' - `INCREMENTAL_COPY` - Copies only the snapshot data that's changed
#' since the previous replication.
#'
#' `CLONE` isn't a valid copy strategy option for the
#' [`copy_snapshot_and_update_volume`][fsx_copy_snapshot_and_update_volume]
#' operation.
#' @param Options Confirms that you want to delete data on the destination volume that
#' wasn’t there during the previous snapshot replication.
#'
#' Your replication will fail if you don’t include an option for a specific
#' type of data and that data is on your destination. For example, if you
#' don’t include `DELETE_INTERMEDIATE_SNAPSHOTS` and there are intermediate
#' snapshots on the destination, you can’t copy the snapshot.
#'
#' - `DELETE_INTERMEDIATE_SNAPSHOTS` - Deletes snapshots on the
#' destination volume that aren’t on the source volume.
#'
#' - `DELETE_CLONED_VOLUMES` - Deletes snapshot clones on the destination
#' volume that aren't on the source volume.
#'
#' - `DELETE_INTERMEDIATE_DATA` - Overwrites snapshots on the destination
#' volume that don’t match the source snapshot that you’re copying.
#'
#' @keywords internal
#'
#' @rdname fsx_copy_snapshot_and_update_volume
fsx_copy_snapshot_and_update_volume <- function(ClientRequestToken = NULL, VolumeId, SourceSnapshotARN, CopyStrategy = NULL, Options = NULL) {
op <- new_operation(
name = "CopySnapshotAndUpdateVolume",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$copy_snapshot_and_update_volume_input(ClientRequestToken = ClientRequestToken, VolumeId = VolumeId, SourceSnapshotARN = SourceSnapshotARN, CopyStrategy = CopyStrategy, Options = Options)
output <- .fsx$copy_snapshot_and_update_volume_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$copy_snapshot_and_update_volume <- fsx_copy_snapshot_and_update_volume
#' Creates a backup of an existing Amazon FSx for Windows File Server file
#' system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP
#' volume, or Amazon FSx for OpenZFS file system
#'
#' @description
#' Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_backup/](https://www.paws-r-sdk.com/docs/fsx_create_backup/) for full documentation.
#'
#' @param FileSystemId The ID of the file system to back up.
#' @param ClientRequestToken (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to
#' ensure idempotent creation. This string is automatically filled on your
#' behalf when you use the Command Line Interface (CLI) or an Amazon Web
#' Services SDK.
#' @param Tags (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 [`create_backup`][fsx_create_backup] operation, no
#' existing file system tags are copied from the file system to the backup.
#' @param VolumeId (Optional) The ID of the FSx for ONTAP volume to back up.
#'
#' @keywords internal
#'
#' @rdname fsx_create_backup
fsx_create_backup <- function(FileSystemId = NULL, ClientRequestToken = NULL, Tags = NULL, VolumeId = NULL) {
op <- new_operation(
name = "CreateBackup",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_backup_input(FileSystemId = FileSystemId, ClientRequestToken = ClientRequestToken, Tags = Tags, VolumeId = VolumeId)
output <- .fsx$create_backup_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_backup <- fsx_create_backup
#' Creates an Amazon FSx for Lustre data repository association (DRA)
#'
#' @description
#' Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding `scratch_1` deployment type.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_data_repository_association/](https://www.paws-r-sdk.com/docs/fsx_create_data_repository_association/) for full documentation.
#'
#' @param FileSystemId [required]
#' @param FileSystemPath A path on the file system that points to a high-level directory (such as
#' `/ns1/`) or subdirectory (such as `/ns1/subdir/`) that will be mapped
#' 1-1 with `DataRepositoryPath`. The leading forward slash in the name is
#' required. Two data repository associations cannot have overlapping file
#' system paths. For example, if a data repository is associated with file
#' system path `/ns1/`, then you cannot link another data repository with
#' file system path `/ns1/ns2`.
#'
#' This path specifies where in your file system files will be exported
#' from or imported to. This file system directory can be linked to only
#' one Amazon S3 bucket, and no other S3 bucket can be linked to the
#' directory.
#'
#' If you specify only a forward slash (`/`) as the file system path, you
#' can link only one data repository to the file system. You can only
#' specify "/" as the file system path for the first data repository
#' associated with a file system.
#' @param DataRepositoryPath [required] The path to the Amazon S3 data repository that will be linked to the
#' file system. The path can be an S3 bucket or prefix in the format
#' `s3://myBucket/myPrefix/`. This path specifies where in the S3 data
#' repository files will be imported from or exported to.
#' @param BatchImportMetaDataOnCreate Set to `true` to run an import data repository task to import metadata
#' from the data repository to the file system after the data repository
#' association is created. Default is `false`.
#' @param ImportedFileChunkSize 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.
#' @param S3 The configuration for an Amazon S3 data repository linked to an Amazon
#' FSx Lustre file system with a data repository association. The
#' configuration defines which file events (new, changed, or deleted files
#' or directories) are automatically imported from the linked data
#' repository to the file system or automatically exported from the file
#' system to the data repository.
#' @param ClientRequestToken
#' @param Tags
#'
#' @keywords internal
#'
#' @rdname fsx_create_data_repository_association
fsx_create_data_repository_association <- function(FileSystemId, FileSystemPath = NULL, DataRepositoryPath, BatchImportMetaDataOnCreate = NULL, ImportedFileChunkSize = NULL, S3 = NULL, ClientRequestToken = NULL, Tags = NULL) {
op <- new_operation(
name = "CreateDataRepositoryAssociation",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_data_repository_association_input(FileSystemId = FileSystemId, FileSystemPath = FileSystemPath, DataRepositoryPath = DataRepositoryPath, BatchImportMetaDataOnCreate = BatchImportMetaDataOnCreate, ImportedFileChunkSize = ImportedFileChunkSize, S3 = S3, ClientRequestToken = ClientRequestToken, Tags = Tags)
output <- .fsx$create_data_repository_association_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_data_repository_association <- fsx_create_data_repository_association
#' Creates an Amazon FSx for Lustre data repository task
#'
#' @description
#' Creates an Amazon FSx for Lustre data repository task. A [`create_data_repository_task`][fsx_create_data_repository_task] operation will fail if a data repository is not linked to the FSx file system.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_data_repository_task/](https://www.paws-r-sdk.com/docs/fsx_create_data_repository_task/) for full documentation.
#'
#' @param Type [required] Specifies the type of data repository task to create.
#'
#' - `EXPORT_TO_REPOSITORY` tasks export from your Amazon FSx for Lustre
#' file system to a linked data repository.
#'
#' - `IMPORT_METADATA_FROM_REPOSITORY` tasks import metadata changes from
#' a linked S3 bucket to your Amazon FSx for Lustre file system.
#'
#' - `RELEASE_DATA_FROM_FILESYSTEM` tasks release files in your Amazon
#' FSx for Lustre file system that have been exported to a linked S3
#' bucket and that meet your specified release criteria.
#'
#' - `AUTO_RELEASE_DATA` tasks automatically release files from an Amazon
#' File Cache resource.
#' @param Paths A list of paths for the data repository task to use when the task is
#' processed. If a path that you provide isn't valid, the task fails. If
#' you don't provide paths, the default behavior is to export all files to
#' S3 (for export tasks), import all files from S3 (for import tasks), or
#' release all exported files that meet the last accessed time criteria
#' (for release tasks).
#'
#' - For export tasks, the list contains paths on the FSx for Lustre file
#' system from which the files are exported to the Amazon S3 bucket.
#' The default path is the file system root directory. The paths you
#' provide need to be relative to the mount point of the file system.
#' If the mount point is `/mnt/fsx` and `/mnt/fsx/path1` is a directory
#' or file on the file system you want to export, then the path to
#' provide is `path1`.
#'
#' - For import tasks, the list contains paths in the Amazon S3 bucket
#' from which POSIX metadata changes are imported to the FSx for Lustre
#' file system. The path can be an S3 bucket or prefix in the format
#' `s3://myBucket/myPrefix` (where `myPrefix` is optional).
#'
#' - For release tasks, the list contains directory or file paths on the
#' FSx for Lustre file system from which to release exported files. If
#' a directory is specified, files within the directory are released.
#' If a file path is specified, only that file is released. To release
#' all exported files in the file system, specify a forward slash (/)
#' as the path.
#'
#' A file must also meet the last accessed time criteria specified in
#' for the file to be released.
#' @param FileSystemId [required]
#' @param Report [required] Defines whether or not Amazon FSx provides a CompletionReport once the
#' task has completed. A CompletionReport provides a detailed report on the
#' files that Amazon FSx processed that meet the criteria specified by the
#' `Scope` parameter. For more information, see [Working with Task
#' Completion
#' Reports](https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html).
#' @param ClientRequestToken
#' @param Tags
#' @param CapacityToRelease Specifies the amount of data to release, in GiB, by an Amazon File Cache
#' `AUTO_RELEASE_DATA` task that automatically releases files from the
#' cache.
#' @param ReleaseConfiguration The configuration that specifies the last accessed time criteria for
#' files that will be released from an Amazon FSx for Lustre file system.
#'
#' @keywords internal
#'
#' @rdname fsx_create_data_repository_task
fsx_create_data_repository_task <- function(Type, Paths = NULL, FileSystemId, Report, ClientRequestToken = NULL, Tags = NULL, CapacityToRelease = NULL, ReleaseConfiguration = NULL) {
op <- new_operation(
name = "CreateDataRepositoryTask",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_data_repository_task_input(Type = Type, Paths = Paths, FileSystemId = FileSystemId, Report = Report, ClientRequestToken = ClientRequestToken, Tags = Tags, CapacityToRelease = CapacityToRelease, ReleaseConfiguration = ReleaseConfiguration)
output <- .fsx$create_data_repository_task_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_data_repository_task <- fsx_create_data_repository_task
#' Creates a new Amazon File Cache resource
#'
#' @description
#' Creates a new Amazon File Cache resource.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_file_cache/](https://www.paws-r-sdk.com/docs/fsx_create_file_cache/) for full documentation.
#'
#' @param ClientRequestToken An idempotency token for resource creation, in a string of up to 63
#' ASCII characters. This token is automatically filled on your behalf when
#' you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
#'
#' By using the idempotent operation, you can retry a
#' [`create_file_cache`][fsx_create_file_cache] operation without the risk
#' of creating an extra cache. This approach can be useful when an initial
#' call fails in a way that makes it unclear whether a cache was created.
#' Examples are if a transport level timeout occurred, or your connection
#' was reset. If you use the same client request token and the initial call
#' created a cache, the client receives success as long as the parameters
#' are the same.
#' @param FileCacheType [required] The type of cache that you're creating, which must be `LUSTRE`.
#' @param FileCacheTypeVersion [required] Sets the Lustre version for the cache that you're creating, which must
#' be `2.12`.
#' @param StorageCapacity [required] The storage capacity of the cache in gibibytes (GiB). Valid values are
#' 1200 GiB, 2400 GiB, and increments of 2400 GiB.
#' @param SubnetIds [required]
#' @param SecurityGroupIds A list of IDs specifying the security groups to apply to all network
#' interfaces created for Amazon File Cache access. This list isn't
#' returned in later requests to describe the cache.
#' @param Tags
#' @param CopyTagsToDataRepositoryAssociations A boolean flag indicating whether tags for the cache should be copied to
#' data repository associations. This value defaults to false.
#' @param KmsKeyId Specifies the ID of the Key Management Service (KMS) key to use for
#' encrypting data on an Amazon File Cache. If a `KmsKeyId` isn't
#' specified, the Amazon FSx-managed KMS key for your account is used. For
#' more information, see
#' [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html)
#' in the *Key Management Service API Reference*.
#' @param LustreConfiguration The configuration for the Amazon File Cache resource being created.
#' @param DataRepositoryAssociations A list of up to 8 configurations for data repository associations (DRAs)
#' to be created during the cache creation. The DRAs link the cache to
#' either an Amazon S3 data repository or a Network File System (NFS) data
#' repository that supports the NFSv3 protocol.
#'
#' The DRA configurations must meet the following requirements:
#'
#' - All configurations on the list must be of the same data repository
#' type, either all S3 or all NFS. A cache can't link to different data
#' repository types at the same time.
#'
#' - An NFS DRA must link to an NFS file system that supports the NFSv3
#' protocol.
#'
#' DRA automatic import and automatic export is not supported.
#'
#' @keywords internal
#'
#' @rdname fsx_create_file_cache
fsx_create_file_cache <- function(ClientRequestToken = NULL, FileCacheType, FileCacheTypeVersion, StorageCapacity, SubnetIds, SecurityGroupIds = NULL, Tags = NULL, CopyTagsToDataRepositoryAssociations = NULL, KmsKeyId = NULL, LustreConfiguration = NULL, DataRepositoryAssociations = NULL) {
op <- new_operation(
name = "CreateFileCache",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_file_cache_input(ClientRequestToken = ClientRequestToken, FileCacheType = FileCacheType, FileCacheTypeVersion = FileCacheTypeVersion, StorageCapacity = StorageCapacity, SubnetIds = SubnetIds, SecurityGroupIds = SecurityGroupIds, Tags = Tags, CopyTagsToDataRepositoryAssociations = CopyTagsToDataRepositoryAssociations, KmsKeyId = KmsKeyId, LustreConfiguration = LustreConfiguration, DataRepositoryAssociations = DataRepositoryAssociations)
output <- .fsx$create_file_cache_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_file_cache <- fsx_create_file_cache
#' Creates a new, empty Amazon FSx file system
#'
#' @description
#' Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the [`create_file_system`][fsx_create_file_system] API operation:
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_file_system/](https://www.paws-r-sdk.com/docs/fsx_create_file_system/) for full documentation.
#'
#' @param ClientRequestToken A string of up to 63 ASCII characters that Amazon FSx uses to ensure
#' idempotent creation. This string is automatically filled on your behalf
#' when you use the Command Line Interface (CLI) or an Amazon Web Services
#' SDK.
#' @param FileSystemType [required] The type of Amazon FSx file system to create. Valid values are
#' `WINDOWS`, `LUSTRE`, `ONTAP`, and `OPENZFS`.
#' @param StorageCapacity [required] Sets the storage capacity of the file system that you're creating, in
#' gibibytes (GiB).
#'
#' **FSx for Lustre file systems** - The amount of storage capacity that
#' you can configure depends on the value that you set for `StorageType`
#' and the Lustre `DeploymentType`, as follows:
#'
#' - For `SCRATCH_2`, `PERSISTENT_2`, and `PERSISTENT_1` deployment types
#' using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and
#' increments of 2400 GiB.
#'
#' - For `PERSISTENT_1` HDD file systems, valid values are increments of
#' 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for
#' 40 MB/s/TiB file systems.
#'
#' - For `SCRATCH_1` deployment type, valid values are 1200 GiB, 2400
#' GiB, and increments of 3600 GiB.
#'
#' **FSx for ONTAP file systems** - The amount of storage capacity that you
#' can configure depends on the value of the `HAPairs` property. The
#' minimum value is calculated as 1,024 * `HAPairs` and the maximum is
#' calculated as 524,288 * `HAPairs`.
#'
#' **FSx for OpenZFS file systems** - The amount of storage capacity that
#' you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
#'
#' **FSx for Windows File Server file systems** - The amount of storage
#' capacity that you can configure depends on the value that you set for
#' `StorageType` as follows:
#'
#' - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
#'
#' - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
#' @param StorageType Sets the storage type for the file system that you're creating. Valid
#' values are `SSD` and `HDD`.
#'
#' - Set to `SSD` to use solid state drive storage. SSD is supported on
#' all Windows, Lustre, ONTAP, and OpenZFS deployment types.
#'
#' - Set to `HDD` to use hard disk drive storage. HDD is supported on
#' `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types,
#' and on `PERSISTENT_1` Lustre file system deployment types.
#'
#' Default value is `SSD`. For more information, see [Storage type
#' options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-configuration.html#optimize-storage-costs)
#' in the *FSx for Windows File Server User Guide* and [Multiple storage
#' options](https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options)
#' in the *FSx for Lustre User Guide*.
#' @param SubnetIds [required] Specifies the IDs of the subnets that the file system will be accessible
#' from. For Windows and ONTAP `MULTI_AZ_1` deployment types,provide
#' exactly two subnet IDs, one for the preferred file server and one for
#' the standby file server. You specify one of these subnets as the
#' preferred subnet using the `WindowsConfiguration > PreferredSubnetID` or
#' `OntapConfiguration > PreferredSubnetID` properties. For more
#' information about Multi-AZ file system configuration, see [Availability
#' and durability: Single-AZ and Multi-AZ file
#' systems](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html)
#' in the *Amazon FSx for Windows User Guide* and [Availability and
#' durability](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/) in the
#' *Amazon FSx for ONTAP User Guide*.
#'
#' For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` and all Lustre deployment
#' types, provide exactly one subnet ID. The file server is launched in
#' that subnet's Availability Zone.
#' @param SecurityGroupIds A list of IDs specifying the security groups to apply to all network
#' interfaces created for file system access. This list isn't returned in
#' later requests to describe the file system.
#'
#' You must specify a security group if you are creating a Multi-AZ FSx for
#' ONTAP file system in a VPC subnet that has been shared with you.
#' @param Tags The tags to apply to the file system that's being created. The key value
#' of the `Name` tag appears in the console as the file system name.
#' @param KmsKeyId
#' @param WindowsConfiguration The Microsoft Windows configuration for the file system that's being
#' created.
#' @param LustreConfiguration
#' @param OntapConfiguration
#' @param FileSystemTypeVersion For FSx for Lustre file systems, sets the Lustre version for the file
#' system that you're creating. Valid values are `2.10`, `2.12`, and
#' `2.15`:
#'
#' - `2.10` is supported by the Scratch and Persistent_1 Lustre
#' deployment types.
#'
#' - `2.12` is supported by all Lustre deployment types, except for
#' `PERSISTENT_2` with a metadata configuration mode.
#'
#' - `2.15` is supported by all Lustre deployment types and is
#' recommended for all new file systems.
#'
#' Default value is `2.10`, except for the following deployments:
#'
#' - Default value is `2.12` when `DeploymentType` is set to
#' `PERSISTENT_2` without a metadata configuration mode.
#'
#' - Default value is `2.15` when `DeploymentType` is set to
#' `PERSISTENT_2` with a metadata configuration mode.
#' @param OpenZFSConfiguration The OpenZFS configuration for the file system that's being created.
#'
#' @keywords internal
#'
#' @rdname fsx_create_file_system
fsx_create_file_system <- function(ClientRequestToken = NULL, FileSystemType, StorageCapacity, StorageType = NULL, SubnetIds, SecurityGroupIds = NULL, Tags = NULL, KmsKeyId = NULL, WindowsConfiguration = NULL, LustreConfiguration = NULL, OntapConfiguration = NULL, FileSystemTypeVersion = NULL, OpenZFSConfiguration = NULL) {
op <- new_operation(
name = "CreateFileSystem",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_file_system_input(ClientRequestToken = ClientRequestToken, FileSystemType = FileSystemType, StorageCapacity = StorageCapacity, StorageType = StorageType, SubnetIds = SubnetIds, SecurityGroupIds = SecurityGroupIds, Tags = Tags, KmsKeyId = KmsKeyId, WindowsConfiguration = WindowsConfiguration, LustreConfiguration = LustreConfiguration, OntapConfiguration = OntapConfiguration, FileSystemTypeVersion = FileSystemTypeVersion, OpenZFSConfiguration = OpenZFSConfiguration)
output <- .fsx$create_file_system_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_file_system <- fsx_create_file_system
#' Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server,
#' or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup
#'
#' @description
#' Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_file_system_from_backup/](https://www.paws-r-sdk.com/docs/fsx_create_file_system_from_backup/) for full documentation.
#'
#' @param BackupId [required]
#' @param ClientRequestToken A string of up to 63 ASCII characters that Amazon FSx uses to ensure
#' idempotent creation. This string is automatically filled on your behalf
#' when you use the Command Line Interface (CLI) or an Amazon Web Services
#' SDK.
#' @param SubnetIds [required] Specifies the IDs of the subnets that the file system will be accessible
#' from. For Windows `MULTI_AZ_1` file system deployment types, provide
#' exactly two subnet IDs, one for the preferred file server and one for
#' the standby file server. You specify one of these subnets as the
#' preferred subnet using the `WindowsConfiguration > PreferredSubnetID`
#' property.
#'
#' Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment types,
#' Lustre file systems, and OpenZFS file systems provide exactly one subnet
#' ID. The file server is launched in that subnet's Availability Zone.
#' @param SecurityGroupIds A list of IDs for the security groups that apply to the specified
#' network interfaces created for file system access. These security groups
#' apply to all network interfaces. This value isn't returned in later
#' `DescribeFileSystem` requests.
#' @param Tags The tags to be applied to the file system at file system creation. The
#' key value of the `Name` tag appears in the console as the file system
#' name.
#' @param WindowsConfiguration The configuration for this Microsoft Windows file system.
#' @param LustreConfiguration
#' @param StorageType Sets the storage type for the Windows or OpenZFS file system that you're
#' creating from a backup. Valid values are `SSD` and `HDD`.
#'
#' - Set to `SSD` to use solid state drive storage. SSD is supported on
#' all Windows and OpenZFS deployment types.
#'
#' - Set to `HDD` to use hard disk drive storage. HDD is supported on
#' `SINGLE_AZ_2` and `MULTI_AZ_1` FSx for Windows File Server file
#' system deployment types.
#'
#' The default value is `SSD`.
#'
#' HDD and SSD storage types have different minimum storage capacity
#' requirements. A restored file system's storage capacity is tied to the
#' file system that was backed up. You can create a file system that uses
#' HDD storage from a backup of a file system that used SSD storage if the
#' original SSD file system had a storage capacity of at least 2000 GiB.
#' @param KmsKeyId
#' @param FileSystemTypeVersion Sets the version for the Amazon FSx for Lustre file system that you're
#' creating from a backup. Valid values are `2.10`, `2.12`, and `2.15`.
#'
#' You don't need to specify `FileSystemTypeVersion` because it will be
#' applied using the backup's `FileSystemTypeVersion` setting. If you
#' choose to specify `FileSystemTypeVersion` when creating from backup, the
#' value must match the backup's `FileSystemTypeVersion` setting.
#' @param OpenZFSConfiguration The OpenZFS configuration for the file system that's being created.
#' @param StorageCapacity Sets the storage capacity of the OpenZFS file system that you're
#' creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB
#' up to 524,288 GiB (512 TiB). However, the value that you specify must be
#' equal to or greater than the backup's storage capacity value. If you
#' don't use the `StorageCapacity` parameter, the default is the backup's
#' `StorageCapacity` value.
#'
#' If used to create a file system other than OpenZFS, you must provide a
#' value that matches the backup's `StorageCapacity` value. If you provide
#' any other value, Amazon FSx responds with with an HTTP status code 400
#' Bad Request.
#'
#' @keywords internal
#'
#' @rdname fsx_create_file_system_from_backup
fsx_create_file_system_from_backup <- function(BackupId, ClientRequestToken = NULL, SubnetIds, SecurityGroupIds = NULL, Tags = NULL, WindowsConfiguration = NULL, LustreConfiguration = NULL, StorageType = NULL, KmsKeyId = NULL, FileSystemTypeVersion = NULL, OpenZFSConfiguration = NULL, StorageCapacity = NULL) {
op <- new_operation(
name = "CreateFileSystemFromBackup",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_file_system_from_backup_input(BackupId = BackupId, ClientRequestToken = ClientRequestToken, SubnetIds = SubnetIds, SecurityGroupIds = SecurityGroupIds, Tags = Tags, WindowsConfiguration = WindowsConfiguration, LustreConfiguration = LustreConfiguration, StorageType = StorageType, KmsKeyId = KmsKeyId, FileSystemTypeVersion = FileSystemTypeVersion, OpenZFSConfiguration = OpenZFSConfiguration, StorageCapacity = StorageCapacity)
output <- .fsx$create_file_system_from_backup_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_file_system_from_backup <- fsx_create_file_system_from_backup
#' Creates a snapshot of an existing Amazon FSx for OpenZFS volume
#'
#' @description
#' Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_snapshot/](https://www.paws-r-sdk.com/docs/fsx_create_snapshot/) for full documentation.
#'
#' @param ClientRequestToken
#' @param Name [required] The name of the snapshot.
#' @param VolumeId [required] The ID of the volume that you are taking a snapshot of.
#' @param Tags
#'
#' @keywords internal
#'
#' @rdname fsx_create_snapshot
fsx_create_snapshot <- function(ClientRequestToken = NULL, Name, VolumeId, Tags = NULL) {
op <- new_operation(
name = "CreateSnapshot",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_snapshot_input(ClientRequestToken = ClientRequestToken, Name = Name, VolumeId = VolumeId, Tags = Tags)
output <- .fsx$create_snapshot_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_snapshot <- fsx_create_snapshot
#' Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file
#' system
#'
#' @description
#' Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_storage_virtual_machine/](https://www.paws-r-sdk.com/docs/fsx_create_storage_virtual_machine/) for full documentation.
#'
#' @param ActiveDirectoryConfiguration Describes the self-managed Microsoft Active Directory to which you want
#' to join the SVM. Joining an Active Directory provides user
#' authentication and access control for SMB clients, including Microsoft
#' Windows and macOS clients accessing the file system.
#' @param ClientRequestToken
#' @param FileSystemId [required]
#' @param Name [required] The name of the SVM.
#' @param SvmAdminPassword The password to use when managing the SVM using the NetApp ONTAP CLI or
#' REST API. If you do not specify a password, you can still use the file
#' system's `fsxadmin` user to manage the SVM.
#' @param Tags
#' @param RootVolumeSecurityStyle The security style of the root volume of the SVM. Specify one of the
#' following values:
#'
#' - `UNIX` if the file system is managed by a UNIX administrator, the
#' majority of users are NFS clients, and an application accessing the
#' data uses a UNIX user as the service account.
#'
#' - `NTFS` if the file system is managed by a Microsoft Windows
#' administrator, the majority of users are SMB clients, and an
#' application accessing the data uses a Microsoft Windows user as the
#' service account.
#'
#' - `MIXED` This is an advanced setting. For more information, see
#' [Volume security
#' style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/) in the
#' Amazon FSx for NetApp ONTAP User Guide.
#'
#' @keywords internal
#'
#' @rdname fsx_create_storage_virtual_machine
fsx_create_storage_virtual_machine <- function(ActiveDirectoryConfiguration = NULL, ClientRequestToken = NULL, FileSystemId, Name, SvmAdminPassword = NULL, Tags = NULL, RootVolumeSecurityStyle = NULL) {
op <- new_operation(
name = "CreateStorageVirtualMachine",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_storage_virtual_machine_input(ActiveDirectoryConfiguration = ActiveDirectoryConfiguration, ClientRequestToken = ClientRequestToken, FileSystemId = FileSystemId, Name = Name, SvmAdminPassword = SvmAdminPassword, Tags = Tags, RootVolumeSecurityStyle = RootVolumeSecurityStyle)
output <- .fsx$create_storage_virtual_machine_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_storage_virtual_machine <- fsx_create_storage_virtual_machine
#' Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume
#'
#' @description
#' Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_volume/](https://www.paws-r-sdk.com/docs/fsx_create_volume/) for full documentation.
#'
#' @param ClientRequestToken
#' @param VolumeType [required] Specifies the type of volume to create; `ONTAP` and `OPENZFS` are the
#' only valid volume types.
#' @param Name [required] Specifies the name of the volume that you're creating.
#' @param OntapConfiguration Specifies the configuration to use when creating the ONTAP volume.
#' @param Tags
#' @param OpenZFSConfiguration Specifies the configuration to use when creating the OpenZFS volume.
#'
#' @keywords internal
#'
#' @rdname fsx_create_volume
fsx_create_volume <- function(ClientRequestToken = NULL, VolumeType, Name, OntapConfiguration = NULL, Tags = NULL, OpenZFSConfiguration = NULL) {
op <- new_operation(
name = "CreateVolume",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_volume_input(ClientRequestToken = ClientRequestToken, VolumeType = VolumeType, Name = Name, OntapConfiguration = OntapConfiguration, Tags = Tags, OpenZFSConfiguration = OpenZFSConfiguration)
output <- .fsx$create_volume_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_volume <- fsx_create_volume
#' Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon
#' FSx volume backup
#'
#' @description
#' Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_create_volume_from_backup/](https://www.paws-r-sdk.com/docs/fsx_create_volume_from_backup/) for full documentation.
#'
#' @param BackupId [required]
#' @param ClientRequestToken
#' @param Name [required] The name of the new volume you're creating.
#' @param OntapConfiguration Specifies the configuration of the ONTAP volume that you are creating.
#' @param Tags
#'
#' @keywords internal
#'
#' @rdname fsx_create_volume_from_backup
fsx_create_volume_from_backup <- function(BackupId, ClientRequestToken = NULL, Name, OntapConfiguration = NULL, Tags = NULL) {
op <- new_operation(
name = "CreateVolumeFromBackup",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$create_volume_from_backup_input(BackupId = BackupId, ClientRequestToken = ClientRequestToken, Name = Name, OntapConfiguration = OntapConfiguration, Tags = Tags)
output <- .fsx$create_volume_from_backup_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$create_volume_from_backup <- fsx_create_volume_from_backup
#' Deletes an Amazon FSx backup
#'
#' @description
#' Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_delete_backup/](https://www.paws-r-sdk.com/docs/fsx_delete_backup/) for full documentation.
#'
#' @param BackupId [required] The ID of the backup that you want to delete.
#' @param ClientRequestToken A string of up to 63 ASCII characters that Amazon FSx uses to ensure
#' idempotent deletion. This parameter is automatically filled on your
#' behalf when using the CLI or SDK.
#'
#' @keywords internal
#'
#' @rdname fsx_delete_backup
fsx_delete_backup <- function(BackupId, ClientRequestToken = NULL) {
op <- new_operation(
name = "DeleteBackup",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$delete_backup_input(BackupId = BackupId, ClientRequestToken = ClientRequestToken)
output <- .fsx$delete_backup_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$delete_backup <- fsx_delete_backup
#' Deletes a data repository association on an Amazon FSx for Lustre file
#' system
#'
#' @description
#' Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding `scratch_1` deployment type.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_delete_data_repository_association/](https://www.paws-r-sdk.com/docs/fsx_delete_data_repository_association/) for full documentation.
#'
#' @param AssociationId [required] The ID of the data repository association that you want to delete.
#' @param ClientRequestToken
#' @param DeleteDataInFileSystem Set to `true` to delete the data in the file system that corresponds to
#' the data repository association.
#'
#' @keywords internal
#'
#' @rdname fsx_delete_data_repository_association
fsx_delete_data_repository_association <- function(AssociationId, ClientRequestToken = NULL, DeleteDataInFileSystem = NULL) {
op <- new_operation(
name = "DeleteDataRepositoryAssociation",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$delete_data_repository_association_input(AssociationId = AssociationId, ClientRequestToken = ClientRequestToken, DeleteDataInFileSystem = DeleteDataInFileSystem)
output <- .fsx$delete_data_repository_association_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$delete_data_repository_association <- fsx_delete_data_repository_association
#' Deletes an Amazon File Cache resource
#'
#' @description
#' Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_delete_file_cache/](https://www.paws-r-sdk.com/docs/fsx_delete_file_cache/) for full documentation.
#'
#' @param FileCacheId [required] The ID of the cache that's being deleted.
#' @param ClientRequestToken
#'
#' @keywords internal
#'
#' @rdname fsx_delete_file_cache
fsx_delete_file_cache <- function(FileCacheId, ClientRequestToken = NULL) {
op <- new_operation(
name = "DeleteFileCache",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$delete_file_cache_input(FileCacheId = FileCacheId, ClientRequestToken = ClientRequestToken)
output <- .fsx$delete_file_cache_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$delete_file_cache <- fsx_delete_file_cache
#' Deletes a file system
#'
#' @description
#' Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_delete_file_system/](https://www.paws-r-sdk.com/docs/fsx_delete_file_system/) for full documentation.
#'
#' @param FileSystemId [required] The ID of the file system that you want to delete.
#' @param ClientRequestToken A string of up to 63 ASCII characters that Amazon FSx uses to ensure
#' idempotent deletion. This token is automatically filled on your behalf
#' when using the Command Line Interface (CLI) or an Amazon Web Services
#' SDK.
#' @param WindowsConfiguration
#' @param LustreConfiguration
#' @param OpenZFSConfiguration The configuration object for the OpenZFS file system used in the
#' [`delete_file_system`][fsx_delete_file_system] operation.
#'
#' @keywords internal
#'
#' @rdname fsx_delete_file_system
fsx_delete_file_system <- function(FileSystemId, ClientRequestToken = NULL, WindowsConfiguration = NULL, LustreConfiguration = NULL, OpenZFSConfiguration = NULL) {
op <- new_operation(
name = "DeleteFileSystem",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$delete_file_system_input(FileSystemId = FileSystemId, ClientRequestToken = ClientRequestToken, WindowsConfiguration = WindowsConfiguration, LustreConfiguration = LustreConfiguration, OpenZFSConfiguration = OpenZFSConfiguration)
output <- .fsx$delete_file_system_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$delete_file_system <- fsx_delete_file_system
#' Deletes an Amazon FSx for OpenZFS snapshot
#'
#' @description
#' Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_delete_snapshot/](https://www.paws-r-sdk.com/docs/fsx_delete_snapshot/) for full documentation.
#'
#' @param ClientRequestToken
#' @param SnapshotId [required] The ID of the snapshot that you want to delete.
#'
#' @keywords internal
#'
#' @rdname fsx_delete_snapshot
fsx_delete_snapshot <- function(ClientRequestToken = NULL, SnapshotId) {
op <- new_operation(
name = "DeleteSnapshot",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$delete_snapshot_input(ClientRequestToken = ClientRequestToken, SnapshotId = SnapshotId)
output <- .fsx$delete_snapshot_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$delete_snapshot <- fsx_delete_snapshot
#' Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM)
#'
#' @description
#' Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_delete_storage_virtual_machine/](https://www.paws-r-sdk.com/docs/fsx_delete_storage_virtual_machine/) for full documentation.
#'
#' @param ClientRequestToken
#' @param StorageVirtualMachineId [required] The ID of the SVM that you want to delete.
#'
#' @keywords internal
#'
#' @rdname fsx_delete_storage_virtual_machine
fsx_delete_storage_virtual_machine <- function(ClientRequestToken = NULL, StorageVirtualMachineId) {
op <- new_operation(
name = "DeleteStorageVirtualMachine",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$delete_storage_virtual_machine_input(ClientRequestToken = ClientRequestToken, StorageVirtualMachineId = StorageVirtualMachineId)
output <- .fsx$delete_storage_virtual_machine_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$delete_storage_virtual_machine <- fsx_delete_storage_virtual_machine
#' Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume
#'
#' @description
#' Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_delete_volume/](https://www.paws-r-sdk.com/docs/fsx_delete_volume/) for full documentation.
#'
#' @param ClientRequestToken
#' @param VolumeId [required] The ID of the volume that you are deleting.
#' @param OntapConfiguration For Amazon FSx for ONTAP volumes, specify whether to take a final backup
#' of the volume and apply tags to the backup. To apply tags to the backup,
#' you must have the `fsx:TagResource` permission.
#' @param OpenZFSConfiguration For Amazon FSx for OpenZFS volumes, specify whether to delete all child
#' volumes and snapshots.
#'
#' @keywords internal
#'
#' @rdname fsx_delete_volume
fsx_delete_volume <- function(ClientRequestToken = NULL, VolumeId, OntapConfiguration = NULL, OpenZFSConfiguration = NULL) {
op <- new_operation(
name = "DeleteVolume",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$delete_volume_input(ClientRequestToken = ClientRequestToken, VolumeId = VolumeId, OntapConfiguration = OntapConfiguration, OpenZFSConfiguration = OpenZFSConfiguration)
output <- .fsx$delete_volume_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$delete_volume <- fsx_delete_volume
#' Returns the description of a specific Amazon FSx backup, if a BackupIds
#' value is provided for that backup
#'
#' @description
#' Returns the description of a specific Amazon FSx backup, if a `BackupIds` value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_backups/](https://www.paws-r-sdk.com/docs/fsx_describe_backups/) for full documentation.
#'
#' @param BackupIds The IDs of the backups that you want to retrieve. This parameter value
#' overrides any filters. If any IDs aren't found, a `BackupNotFound` error
#' occurs.
#' @param Filters The filters structure. The supported names are `file-system-id`,
#' `backup-type`, `file-system-type`, and `volume-id`.
#' @param MaxResults Maximum number of backups to return in the response. 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.
#' @param NextToken An opaque pagination token returned from a previous
#' [`describe_backups`][fsx_describe_backups] operation. If a token is
#' present, the operation continues the list from where the returning call
#' left off.
#'
#' @keywords internal
#'
#' @rdname fsx_describe_backups
fsx_describe_backups <- function(BackupIds = NULL, Filters = NULL, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "DescribeBackups",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults")
)
input <- .fsx$describe_backups_input(BackupIds = BackupIds, Filters = Filters, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$describe_backups_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_backups <- fsx_describe_backups
#' Returns the description of specific Amazon FSx for Lustre or Amazon File
#' Cache data repository associations, if one or more AssociationIds values
#' are provided in the request, or if filters are used in the request
#'
#' @description
#' Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more `AssociationIds` values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding `scratch_1` deployment type.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_data_repository_associations/](https://www.paws-r-sdk.com/docs/fsx_describe_data_repository_associations/) for full documentation.
#'
#' @param AssociationIds IDs of the data repository associations whose descriptions you want to
#' retrieve (String).
#' @param Filters
#' @param MaxResults The maximum number of resources to return in the response. This value
#' must be an integer greater than zero.
#' @param NextToken
#'
#' @keywords internal
#'
#' @rdname fsx_describe_data_repository_associations
fsx_describe_data_repository_associations <- function(AssociationIds = NULL, Filters = NULL, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "DescribeDataRepositoryAssociations",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults")
)
input <- .fsx$describe_data_repository_associations_input(AssociationIds = AssociationIds, Filters = Filters, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$describe_data_repository_associations_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_data_repository_associations <- fsx_describe_data_repository_associations
#' Returns the description of specific Amazon FSx for Lustre or Amazon File
#' Cache data repository tasks, if one or more TaskIds values are provided
#' in the request, or if filters are used in the request
#'
#' @description
#' Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more `TaskIds` values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_data_repository_tasks/](https://www.paws-r-sdk.com/docs/fsx_describe_data_repository_tasks/) for full documentation.
#'
#' @param TaskIds (Optional) IDs of the tasks whose descriptions you want to retrieve
#' (String).
#' @param Filters (Optional) You can use filters to narrow the
#' [`describe_data_repository_tasks`][fsx_describe_data_repository_tasks]
#' response to include just tasks for specific file systems, or tasks in a
#' specific lifecycle state.
#' @param MaxResults
#' @param NextToken
#'
#' @keywords internal
#'
#' @rdname fsx_describe_data_repository_tasks
fsx_describe_data_repository_tasks <- function(TaskIds = NULL, Filters = NULL, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "DescribeDataRepositoryTasks",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults")
)
input <- .fsx$describe_data_repository_tasks_input(TaskIds = TaskIds, Filters = Filters, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$describe_data_repository_tasks_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_data_repository_tasks <- fsx_describe_data_repository_tasks
#' Returns the description of a specific Amazon File Cache resource, if a
#' FileCacheIds value is provided for that cache
#'
#' @description
#' Returns the description of a specific Amazon File Cache resource, if a `FileCacheIds` value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_file_caches/](https://www.paws-r-sdk.com/docs/fsx_describe_file_caches/) for full documentation.
#'
#' @param FileCacheIds IDs of the caches whose descriptions you want to retrieve (String).
#' @param MaxResults
#' @param NextToken
#'
#' @keywords internal
#'
#' @rdname fsx_describe_file_caches
fsx_describe_file_caches <- function(FileCacheIds = NULL, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "DescribeFileCaches",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults")
)
input <- .fsx$describe_file_caches_input(FileCacheIds = FileCacheIds, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$describe_file_caches_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_file_caches <- fsx_describe_file_caches
#' Returns the DNS aliases that are associated with the specified Amazon
#' FSx for Windows File Server file system
#'
#' @description
#' Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the [`describe_file_systems`][fsx_describe_file_systems] operation response.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_file_system_aliases/](https://www.paws-r-sdk.com/docs/fsx_describe_file_system_aliases/) for full documentation.
#'
#' @param ClientRequestToken
#' @param FileSystemId [required] The ID of the file system to return the associated DNS aliases for
#' (String).
#' @param MaxResults Maximum number of DNS aliases to return in the response (integer). This
#' parameter value must be greater than 0. The number of items that Amazon
#' FSx returns is the minimum of the `MaxResults` parameter specified in
#' the request and the service's internal maximum number of items per page.
#' @param NextToken Opaque pagination token returned from a previous
#' [`describe_file_system_aliases`][fsx_describe_file_system_aliases]
#' operation (String). If a token is included in the request, the action
#' continues the list from where the previous returning call left off.
#'
#' @keywords internal
#'
#' @rdname fsx_describe_file_system_aliases
fsx_describe_file_system_aliases <- function(ClientRequestToken = NULL, FileSystemId, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "DescribeFileSystemAliases",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults")
)
input <- .fsx$describe_file_system_aliases_input(ClientRequestToken = ClientRequestToken, FileSystemId = FileSystemId, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$describe_file_system_aliases_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_file_system_aliases <- fsx_describe_file_system_aliases
#' Returns the description of specific Amazon FSx file systems, if a
#' FileSystemIds value is provided for that file system
#'
#' @description
#' Returns the description of specific Amazon FSx file systems, if a `FileSystemIds` value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_file_systems/](https://www.paws-r-sdk.com/docs/fsx_describe_file_systems/) for full documentation.
#'
#' @param FileSystemIds IDs of the file systems whose descriptions you want to retrieve
#' (String).
#' @param MaxResults Maximum number of file systems 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.
#' @param NextToken Opaque pagination token returned from a previous
#' [`describe_file_systems`][fsx_describe_file_systems] operation (String).
#' If a token present, the operation continues the list from where the
#' returning call left off.
#'
#' @keywords internal
#'
#' @rdname fsx_describe_file_systems
fsx_describe_file_systems <- function(FileSystemIds = NULL, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "DescribeFileSystems",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults")
)
input <- .fsx$describe_file_systems_input(FileSystemIds = FileSystemIds, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$describe_file_systems_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_file_systems <- fsx_describe_file_systems
#' Indicates whether participant accounts in your organization can create
#' Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are
#' shared by a virtual private cloud (VPC) owner
#'
#' @description
#' Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see [Creating FSx for ONTAP file systems in shared subnets](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/creating-file-systems.html#fsxn-vpc-shared-subnets).
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_shared_vpc_configuration/](https://www.paws-r-sdk.com/docs/fsx_describe_shared_vpc_configuration/) for full documentation.
#'
#'
#' @keywords internal
#'
#' @rdname fsx_describe_shared_vpc_configuration
fsx_describe_shared_vpc_configuration <- function() {
op <- new_operation(
name = "DescribeSharedVpcConfiguration",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$describe_shared_vpc_configuration_input()
output <- .fsx$describe_shared_vpc_configuration_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_shared_vpc_configuration <- fsx_describe_shared_vpc_configuration
#' Returns the description of specific Amazon FSx for OpenZFS snapshots, if
#' a SnapshotIds value is provided
#'
#' @description
#' Returns the description of specific Amazon FSx for OpenZFS snapshots, if a `SnapshotIds` value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_snapshots/](https://www.paws-r-sdk.com/docs/fsx_describe_snapshots/) for full documentation.
#'
#' @param SnapshotIds The IDs of the snapshots that you want to retrieve. This parameter value
#' overrides any filters. If any IDs aren't found, a `SnapshotNotFound`
#' error occurs.
#' @param Filters The filters structure. The supported names are `file-system-id` or
#' `volume-id`.
#' @param MaxResults
#' @param NextToken
#' @param IncludeShared Set to `false` (default) if you want to only see the snapshots owned by
#' your Amazon Web Services account. Set to `true` if you want to see the
#' snapshots in your account and the ones shared with you from another
#' account.
#'
#' @keywords internal
#'
#' @rdname fsx_describe_snapshots
fsx_describe_snapshots <- function(SnapshotIds = NULL, Filters = NULL, MaxResults = NULL, NextToken = NULL, IncludeShared = NULL) {
op <- new_operation(
name = "DescribeSnapshots",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults")
)
input <- .fsx$describe_snapshots_input(SnapshotIds = SnapshotIds, Filters = Filters, MaxResults = MaxResults, NextToken = NextToken, IncludeShared = IncludeShared)
output <- .fsx$describe_snapshots_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_snapshots <- fsx_describe_snapshots
#' Describes one or more Amazon FSx for NetApp ONTAP storage virtual
#' machines (SVMs)
#'
#' @description
#' Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_storage_virtual_machines/](https://www.paws-r-sdk.com/docs/fsx_describe_storage_virtual_machines/) for full documentation.
#'
#' @param StorageVirtualMachineIds Enter the ID of one or more SVMs that you want to view.
#' @param Filters Enter a filter name:value pair to view a select set of SVMs.
#' @param MaxResults
#' @param NextToken
#'
#' @keywords internal
#'
#' @rdname fsx_describe_storage_virtual_machines
fsx_describe_storage_virtual_machines <- function(StorageVirtualMachineIds = NULL, Filters = NULL, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "DescribeStorageVirtualMachines",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults", result_key = "StorageVirtualMachines")
)
input <- .fsx$describe_storage_virtual_machines_input(StorageVirtualMachineIds = StorageVirtualMachineIds, Filters = Filters, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$describe_storage_virtual_machines_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_storage_virtual_machines <- fsx_describe_storage_virtual_machines
#' Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for
#' OpenZFS volumes
#'
#' @description
#' Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_describe_volumes/](https://www.paws-r-sdk.com/docs/fsx_describe_volumes/) for full documentation.
#'
#' @param VolumeIds The IDs of the volumes whose descriptions you want to retrieve.
#' @param Filters Enter a filter `Name` and `Values` pair to view a select set of volumes.
#' @param MaxResults
#' @param NextToken
#'
#' @keywords internal
#'
#' @rdname fsx_describe_volumes
fsx_describe_volumes <- function(VolumeIds = NULL, Filters = NULL, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "DescribeVolumes",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults", result_key = "Volumes")
)
input <- .fsx$describe_volumes_input(VolumeIds = VolumeIds, Filters = Filters, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$describe_volumes_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$describe_volumes <- fsx_describe_volumes
#' Use this action to disassociate, or remove, one or more Domain Name
#' Service (DNS) aliases from an Amazon FSx for Windows File Server file
#' system
#'
#' @description
#' Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP status code 400 (Bad Request). For more information, see [Working with DNS Aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html).
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_disassociate_file_system_aliases/](https://www.paws-r-sdk.com/docs/fsx_disassociate_file_system_aliases/) for full documentation.
#'
#' @param ClientRequestToken
#' @param FileSystemId [required] Specifies the file system from which to disassociate the DNS aliases.
#' @param Aliases [required] An array of one or more DNS alias names to disassociate, or remove, from
#' the file system.
#'
#' @keywords internal
#'
#' @rdname fsx_disassociate_file_system_aliases
fsx_disassociate_file_system_aliases <- function(ClientRequestToken = NULL, FileSystemId, Aliases) {
op <- new_operation(
name = "DisassociateFileSystemAliases",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$disassociate_file_system_aliases_input(ClientRequestToken = ClientRequestToken, FileSystemId = FileSystemId, Aliases = Aliases)
output <- .fsx$disassociate_file_system_aliases_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$disassociate_file_system_aliases <- fsx_disassociate_file_system_aliases
#' Lists tags for Amazon FSx resources
#'
#' @description
#' Lists tags for Amazon FSx resources.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_list_tags_for_resource/](https://www.paws-r-sdk.com/docs/fsx_list_tags_for_resource/) for full documentation.
#'
#' @param ResourceARN [required] The ARN of the Amazon FSx resource that will have its tags listed.
#' @param MaxResults Maximum number of tags to return in the response (integer). This
#' parameter value must be greater than 0. The number of items that Amazon
#' FSx returns is the minimum of the `MaxResults` parameter specified in
#' the request and the service's internal maximum number of items per page.
#' @param NextToken Opaque pagination token returned from a previous
#' [`list_tags_for_resource`][fsx_list_tags_for_resource] operation
#' (String). If a token present, the action continues the list from where
#' the returning call left off.
#'
#' @keywords internal
#'
#' @rdname fsx_list_tags_for_resource
fsx_list_tags_for_resource <- function(ResourceARN, MaxResults = NULL, NextToken = NULL) {
op <- new_operation(
name = "ListTagsForResource",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list(input_token = "NextToken", output_token = "NextToken", limit_key = "MaxResults")
)
input <- .fsx$list_tags_for_resource_input(ResourceARN = ResourceARN, MaxResults = MaxResults, NextToken = NextToken)
output <- .fsx$list_tags_for_resource_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$list_tags_for_resource <- fsx_list_tags_for_resource
#' Releases the file system lock from an Amazon FSx for OpenZFS file system
#'
#' @description
#' Releases the file system lock from an Amazon FSx for OpenZFS file system.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_release_file_system_nfs_v3_locks/](https://www.paws-r-sdk.com/docs/fsx_release_file_system_nfs_v3_locks/) for full documentation.
#'
#' @param FileSystemId [required]
#' @param ClientRequestToken
#'
#' @keywords internal
#'
#' @rdname fsx_release_file_system_nfs_v3_locks
fsx_release_file_system_nfs_v3_locks <- function(FileSystemId, ClientRequestToken = NULL) {
op <- new_operation(
name = "ReleaseFileSystemNfsV3Locks",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$release_file_system_nfs_v3_locks_input(FileSystemId = FileSystemId, ClientRequestToken = ClientRequestToken)
output <- .fsx$release_file_system_nfs_v3_locks_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$release_file_system_nfs_v3_locks <- fsx_release_file_system_nfs_v3_locks
#' Returns an Amazon FSx for OpenZFS volume to the state saved by the
#' specified snapshot
#'
#' @description
#' Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_restore_volume_from_snapshot/](https://www.paws-r-sdk.com/docs/fsx_restore_volume_from_snapshot/) for full documentation.
#'
#' @param ClientRequestToken
#' @param VolumeId [required] The ID of the volume that you are restoring.
#' @param SnapshotId [required] The ID of the source snapshot. Specifies the snapshot that you are
#' restoring from.
#' @param Options The settings used when restoring the specified volume from snapshot.
#'
#' - `DELETE_INTERMEDIATE_SNAPSHOTS` - Deletes snapshots between the
#' current state and the specified snapshot. If there are intermediate
#' snapshots and this option isn't used,
#' [`restore_volume_from_snapshot`][fsx_restore_volume_from_snapshot]
#' fails.
#'
#' - `DELETE_CLONED_VOLUMES` - Deletes any dependent clone volumes
#' created from intermediate snapshots. If there are any dependent
#' clone volumes and this option isn't used,
#' [`restore_volume_from_snapshot`][fsx_restore_volume_from_snapshot]
#' fails.
#'
#' @keywords internal
#'
#' @rdname fsx_restore_volume_from_snapshot
fsx_restore_volume_from_snapshot <- function(ClientRequestToken = NULL, VolumeId, SnapshotId, Options = NULL) {
op <- new_operation(
name = "RestoreVolumeFromSnapshot",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$restore_volume_from_snapshot_input(ClientRequestToken = ClientRequestToken, VolumeId = VolumeId, SnapshotId = SnapshotId, Options = Options)
output <- .fsx$restore_volume_from_snapshot_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$restore_volume_from_snapshot <- fsx_restore_volume_from_snapshot
#' After performing steps to repair the Active Directory configuration of
#' an FSx for Windows File Server file system, use this action to initiate
#' the process of Amazon FSx attempting to reconnect to the file system
#'
#' @description
#' After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_start_misconfigured_state_recovery/](https://www.paws-r-sdk.com/docs/fsx_start_misconfigured_state_recovery/) for full documentation.
#'
#' @param ClientRequestToken
#' @param FileSystemId [required]
#'
#' @keywords internal
#'
#' @rdname fsx_start_misconfigured_state_recovery
fsx_start_misconfigured_state_recovery <- function(ClientRequestToken = NULL, FileSystemId) {
op <- new_operation(
name = "StartMisconfiguredStateRecovery",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$start_misconfigured_state_recovery_input(ClientRequestToken = ClientRequestToken, FileSystemId = FileSystemId)
output <- .fsx$start_misconfigured_state_recovery_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$start_misconfigured_state_recovery <- fsx_start_misconfigured_state_recovery
#' Tags an Amazon FSx resource
#'
#' @description
#' Tags an Amazon FSx resource.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_tag_resource/](https://www.paws-r-sdk.com/docs/fsx_tag_resource/) for full documentation.
#'
#' @param ResourceARN [required] The Amazon Resource Name (ARN) of the Amazon FSx resource that you want
#' to tag.
#' @param Tags [required] A list of tags for the resource. If a tag with a given key already
#' exists, the value is replaced by the one specified in this parameter.
#'
#' @keywords internal
#'
#' @rdname fsx_tag_resource
fsx_tag_resource <- function(ResourceARN, Tags) {
op <- new_operation(
name = "TagResource",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$tag_resource_input(ResourceARN = ResourceARN, Tags = Tags)
output <- .fsx$tag_resource_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$tag_resource <- fsx_tag_resource
#' This action removes a tag from an Amazon FSx resource
#'
#' @description
#' This action removes a tag from an Amazon FSx resource.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_untag_resource/](https://www.paws-r-sdk.com/docs/fsx_untag_resource/) for full documentation.
#'
#' @param ResourceARN [required] The ARN of the Amazon FSx resource to untag.
#' @param TagKeys [required] A list of keys of tags on the resource to untag. In case the tag key
#' doesn't exist, the call will still succeed to be idempotent.
#'
#' @keywords internal
#'
#' @rdname fsx_untag_resource
fsx_untag_resource <- function(ResourceARN, TagKeys) {
op <- new_operation(
name = "UntagResource",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$untag_resource_input(ResourceARN = ResourceARN, TagKeys = TagKeys)
output <- .fsx$untag_resource_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$untag_resource <- fsx_untag_resource
#' Updates the configuration of an existing data repository association on
#' an Amazon FSx for Lustre file system
#'
#' @description
#' Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding `scratch_1` deployment type.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_update_data_repository_association/](https://www.paws-r-sdk.com/docs/fsx_update_data_repository_association/) for full documentation.
#'
#' @param AssociationId [required] The ID of the data repository association that you are updating.
#' @param ClientRequestToken
#' @param ImportedFileChunkSize 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.
#' @param S3 The configuration for an Amazon S3 data repository linked to an Amazon
#' FSx Lustre file system with a data repository association. The
#' configuration defines which file events (new, changed, or deleted files
#' or directories) are automatically imported from the linked data
#' repository to the file system or automatically exported from the file
#' system to the data repository.
#'
#' @keywords internal
#'
#' @rdname fsx_update_data_repository_association
fsx_update_data_repository_association <- function(AssociationId, ClientRequestToken = NULL, ImportedFileChunkSize = NULL, S3 = NULL) {
op <- new_operation(
name = "UpdateDataRepositoryAssociation",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$update_data_repository_association_input(AssociationId = AssociationId, ClientRequestToken = ClientRequestToken, ImportedFileChunkSize = ImportedFileChunkSize, S3 = S3)
output <- .fsx$update_data_repository_association_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$update_data_repository_association <- fsx_update_data_repository_association
#' Updates the configuration of an existing Amazon File Cache resource
#'
#' @description
#' Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_update_file_cache/](https://www.paws-r-sdk.com/docs/fsx_update_file_cache/) for full documentation.
#'
#' @param FileCacheId [required] The ID of the cache that you are updating.
#' @param ClientRequestToken
#' @param LustreConfiguration The configuration updates for an Amazon File Cache resource.
#'
#' @keywords internal
#'
#' @rdname fsx_update_file_cache
fsx_update_file_cache <- function(FileCacheId, ClientRequestToken = NULL, LustreConfiguration = NULL) {
op <- new_operation(
name = "UpdateFileCache",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$update_file_cache_input(FileCacheId = FileCacheId, ClientRequestToken = ClientRequestToken, LustreConfiguration = LustreConfiguration)
output <- .fsx$update_file_cache_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$update_file_cache <- fsx_update_file_cache
#' Use this operation to update the configuration of an existing Amazon FSx
#' file system
#'
#' @description
#' Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_update_file_system/](https://www.paws-r-sdk.com/docs/fsx_update_file_system/) for full documentation.
#'
#' @param FileSystemId [required] The ID of the file system that you are updating.
#' @param ClientRequestToken A string of up to 63 ASCII characters that Amazon FSx uses to ensure
#' idempotent updates. This string is automatically filled on your behalf
#' when you use the Command Line Interface (CLI) or an Amazon Web Services
#' SDK.
#' @param StorageCapacity Use this parameter to increase the storage capacity of an FSx for
#' Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP
#' file system. Specifies the storage capacity target value, in GiB, to
#' increase the storage capacity for the file system that you're updating.
#'
#' You can't make a storage capacity increase request if there is an
#' existing storage capacity increase request in progress.
#'
#' For Lustre file systems, the storage capacity target value can be the
#' following:
#'
#' - For `SCRATCH_2`, `PERSISTENT_1`, and `PERSISTENT_2 SSD` deployment
#' types, valid values are in multiples of 2400 GiB. The value must be
#' greater than the current storage capacity.
#'
#' - For `PERSISTENT HDD` file systems, valid values are multiples of
#' 6000 GiB for 12-MBps throughput per TiB file systems and multiples
#' of 1800 GiB for 40-MBps throughput per TiB file systems. The values
#' must be greater than the current storage capacity.
#'
#' - For `SCRATCH_1` file systems, you can't increase the storage
#' capacity.
#'
#' For more information, see [Managing storage and throughput
#' capacity](https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html)
#' in the *FSx for Lustre User Guide*.
#'
#' For FSx for OpenZFS file systems, the storage capacity target value must
#' be at least 10 percent greater than the current storage capacity value.
#' For more information, see [Managing storage
#' capacity](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html)
#' in the *FSx for OpenZFS User Guide*.
#'
#' For Windows file systems, the storage capacity target value must be at
#' least 10 percent greater than the current storage capacity value. To
#' increase storage capacity, the file system must have at least 16 MBps of
#' throughput capacity. For more information, see [Managing storage
#' capacity](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-configuration.html#managing-storage-capacity)
#' in the *Amazon FSxfor Windows File Server User Guide*.
#'
#' For ONTAP file systems, the storage capacity target value must be at
#' least 10 percent greater than the current storage capacity value. For
#' more information, see [Managing storage capacity and provisioned
#' IOPS](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html)
#' in the *Amazon FSx for NetApp ONTAP User Guide*.
#' @param WindowsConfiguration The configuration updates for an Amazon FSx for Windows File Server file
#' system.
#' @param LustreConfiguration
#' @param OntapConfiguration
#' @param OpenZFSConfiguration The configuration updates for an FSx for OpenZFS file system.
#' @param StorageType
#'
#' @keywords internal
#'
#' @rdname fsx_update_file_system
fsx_update_file_system <- function(FileSystemId, ClientRequestToken = NULL, StorageCapacity = NULL, WindowsConfiguration = NULL, LustreConfiguration = NULL, OntapConfiguration = NULL, OpenZFSConfiguration = NULL, StorageType = NULL) {
op <- new_operation(
name = "UpdateFileSystem",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$update_file_system_input(FileSystemId = FileSystemId, ClientRequestToken = ClientRequestToken, StorageCapacity = StorageCapacity, WindowsConfiguration = WindowsConfiguration, LustreConfiguration = LustreConfiguration, OntapConfiguration = OntapConfiguration, OpenZFSConfiguration = OpenZFSConfiguration, StorageType = StorageType)
output <- .fsx$update_file_system_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$update_file_system <- fsx_update_file_system
#' Configures whether participant accounts in your organization can create
#' Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are
#' shared by a virtual private cloud (VPC) owner
#'
#' @description
#' Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the [Amazon FSx for NetApp ONTAP User Guide](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/).
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_update_shared_vpc_configuration/](https://www.paws-r-sdk.com/docs/fsx_update_shared_vpc_configuration/) for full documentation.
#'
#' @param EnableFsxRouteTableUpdatesFromParticipantAccounts Specifies whether participant accounts can create FSx for ONTAP Multi-AZ
#' file systems in shared subnets. Set to `true` to enable or `false` to
#' disable.
#' @param ClientRequestToken
#'
#' @keywords internal
#'
#' @rdname fsx_update_shared_vpc_configuration
fsx_update_shared_vpc_configuration <- function(EnableFsxRouteTableUpdatesFromParticipantAccounts = NULL, ClientRequestToken = NULL) {
op <- new_operation(
name = "UpdateSharedVpcConfiguration",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$update_shared_vpc_configuration_input(EnableFsxRouteTableUpdatesFromParticipantAccounts = EnableFsxRouteTableUpdatesFromParticipantAccounts, ClientRequestToken = ClientRequestToken)
output <- .fsx$update_shared_vpc_configuration_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$update_shared_vpc_configuration <- fsx_update_shared_vpc_configuration
#' Updates the name of an Amazon FSx for OpenZFS snapshot
#'
#' @description
#' Updates the name of an Amazon FSx for OpenZFS snapshot.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_update_snapshot/](https://www.paws-r-sdk.com/docs/fsx_update_snapshot/) for full documentation.
#'
#' @param ClientRequestToken
#' @param Name [required] The name of the snapshot to update.
#' @param SnapshotId [required] The ID of the snapshot that you want to update, in the format
#' `fsvolsnap-0123456789abcdef0`.
#'
#' @keywords internal
#'
#' @rdname fsx_update_snapshot
fsx_update_snapshot <- function(ClientRequestToken = NULL, Name, SnapshotId) {
op <- new_operation(
name = "UpdateSnapshot",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$update_snapshot_input(ClientRequestToken = ClientRequestToken, Name = Name, SnapshotId = SnapshotId)
output <- .fsx$update_snapshot_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$update_snapshot <- fsx_update_snapshot
#' Updates an FSx for ONTAP storage virtual machine (SVM)
#'
#' @description
#' Updates an FSx for ONTAP storage virtual machine (SVM).
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_update_storage_virtual_machine/](https://www.paws-r-sdk.com/docs/fsx_update_storage_virtual_machine/) for full documentation.
#'
#' @param ActiveDirectoryConfiguration Specifies updates to an SVM's Microsoft Active Directory (AD)
#' configuration.
#' @param ClientRequestToken
#' @param StorageVirtualMachineId [required] The ID of the SVM that you want to update, in the format
#' `svm-0123456789abcdef0`.
#' @param SvmAdminPassword Specifies a new SvmAdminPassword.
#'
#' @keywords internal
#'
#' @rdname fsx_update_storage_virtual_machine
fsx_update_storage_virtual_machine <- function(ActiveDirectoryConfiguration = NULL, ClientRequestToken = NULL, StorageVirtualMachineId, SvmAdminPassword = NULL) {
op <- new_operation(
name = "UpdateStorageVirtualMachine",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$update_storage_virtual_machine_input(ActiveDirectoryConfiguration = ActiveDirectoryConfiguration, ClientRequestToken = ClientRequestToken, StorageVirtualMachineId = StorageVirtualMachineId, SvmAdminPassword = SvmAdminPassword)
output <- .fsx$update_storage_virtual_machine_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$update_storage_virtual_machine <- fsx_update_storage_virtual_machine
#' Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon
#' FSx for OpenZFS volume
#'
#' @description
#' Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
#'
#' See [https://www.paws-r-sdk.com/docs/fsx_update_volume/](https://www.paws-r-sdk.com/docs/fsx_update_volume/) for full documentation.
#'
#' @param ClientRequestToken
#' @param VolumeId [required] The ID of the volume that you want to update, in the format
#' `fsvol-0123456789abcdef0`.
#' @param OntapConfiguration The configuration of the ONTAP volume that you are updating.
#' @param Name The name of the OpenZFS volume. OpenZFS root volumes are automatically
#' named `FSX`. Child volume names must be unique among their parent
#' volume's children. The name of the volume is part of the mount string
#' for the OpenZFS volume.
#' @param OpenZFSConfiguration The configuration of the OpenZFS volume that you are updating.
#'
#' @keywords internal
#'
#' @rdname fsx_update_volume
fsx_update_volume <- function(ClientRequestToken = NULL, VolumeId, OntapConfiguration = NULL, Name = NULL, OpenZFSConfiguration = NULL) {
op <- new_operation(
name = "UpdateVolume",
http_method = "POST",
http_path = "/",
host_prefix = "",
paginator = list()
)
input <- .fsx$update_volume_input(ClientRequestToken = ClientRequestToken, VolumeId = VolumeId, OntapConfiguration = OntapConfiguration, Name = Name, OpenZFSConfiguration = OpenZFSConfiguration)
output <- .fsx$update_volume_output()
config <- get_config()
svc <- .fsx$service(config, op)
request <- new_request(svc, op, input, output)
response <- send_request(request)
return(response)
}
.fsx$operations$update_volume <- fsx_update_volume
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.