FSx
Service object for interacting with AWS FSx service.
public struct FSx: AWSService
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the FSx client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: FSx, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
associateFileSystemAliases(_:logger:on:)
public func associateFileSystemAliases(_ input: AssociateFileSystemAliasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AssociateFileSystemAliasesResponse>
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 and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.
cancelDataRepositoryTask(_:logger:on:)
public func cancelDataRepositoryTask(_ input: CancelDataRepositoryTaskRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CancelDataRepositoryTaskResponse>
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
PENDING
or EXECUTING
state. When you cancel a task, Amazon FSx does the following.
-
Any files that FSx has already exported are not reverted.
-
FSx continues to export any files that are "in-flight" when the cancel operation is received.
-
FSx does not export any files that have not yet been exported.
copyBackup(_:logger:on:)
public func copyBackup(_ input: CopyBackupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CopyBackupResponse>
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.
You can use cross-Region backup copies for cross-Region disaster recovery. You can
periodically take backups and copy them to another Region so that in the event of a
disaster in the primary Region, you can restore from backup and recover availability
quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently
has three partitions: aws
(Standard Regions), aws-cn
(China
Regions), and aws-us-gov
(Amazon Web Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within the same Region.
You can use the SourceRegion
parameter to specify the Amazon Web Services Region
from which the backup will be copied. For example, if you make the call from the
us-west-1
Region and want to copy a backup from the us-east-2
Region, you specify us-east-2
in the SourceRegion
parameter
to make a cross-Region copy. If you don't specify a Region, the backup copy is
created in the same Region where the request is sent from (in-Region copy).
For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.
createBackup(_:logger:on:)
public func createBackup(_ input: CreateBackupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateBackupResponse>
Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:
-
A Persistent deployment type
-
Are not linked to a data repository
For more information about backups, see the following:
-
For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
-
For Amazon FSx for Windows, see Working with FSx for Windows backups.
-
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
-
For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups.
If a backup with the specified client request token exists and the parameters match,
this operation returns the description of the existing backup. If a backup with the
specified client request token exists and the parameters don't match, this operation
returns IncompatibleParameterError
. If a backup with the specified client
request token doesn't exist, CreateBackup
does the following:
-
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of
CREATING
. -
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup
operation without the risk of creating an extra backup. This approach can be useful when
an initial call fails in a way that makes it unclear whether a backup was created. If
you use the same client request token and the initial call created a backup, the
operation returns a successful result because all the parameters are the same.
The CreateBackup
operation returns while the backup's lifecycle state is
still CREATING
. You can check the backup creation status by calling the
DescribeBackups operation, which returns the backup state along with other
information.
createDataRepositoryAssociation(_:logger:on:)
public func createDataRepositoryAssociation(_ input: CreateDataRepositoryAssociationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDataRepositoryAssociationResponse>
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 only
for file systems with the Persistent_2
deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
createDataRepositoryTask(_:logger:on:)
public func createDataRepositoryTask(_ input: CreateDataRepositoryTaskRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDataRepositoryTaskResponse>
Creates an Amazon FSx for Lustre data repository task. You use data repository tasks
to perform bulk operations between your Amazon FSx file system and its linked data
repositories. An example of a data repository task is exporting any data and metadata
changes, including POSIX metadata, to files, directories, and symbolic links (symlinks)
from your FSx file system to a linked data repository. A CreateDataRepositoryTask
operation will fail if a data repository is not linked to the FSx file system. To learn
more about data repository tasks, see
Data Repository Tasks.
To learn more about linking a data repository to your file system, see
Linking your file system to an S3 bucket.
createFileSystem(_:logger:on:)
public func createFileSystem(_ input: CreateFileSystemRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateFileSystemResponse>
Creates a new, empty Amazon FSx file system. You can create the following supported
Amazon FSx file systems using the CreateFileSystem
API operation:
-
Amazon FSx for Lustre
-
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
This operation requires a client request token in the request that Amazon FSx uses
to ensure idempotent creation. This means that calling the operation multiple times with
the same client request token has no effect. By using the idempotent operation, you can
retry a CreateFileSystem
operation without the risk of creating an extra
file system. This approach can be useful when an initial call fails in a way that makes
it unclear whether a file system was created. Examples are if a transport level timeout
occurred, or your connection was reset. If you use the same client request token and the
initial call created a file system, the client receives success as long as the
parameters are the same.
If a file system with the specified client request token exists and the parameters
match, CreateFileSystem
returns the description of the existing file
system. If a file system with the specified client request token exists and the
parameters don't match, this call returns IncompatibleParameterError
. If a
file system with the specified client request token doesn't exist,
CreateFileSystem
does the following:
-
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of
CREATING
. -
Returns the description of the file system in JSON format.
This operation requires a client request token in the request that Amazon FSx
uses to ensure idempotent creation. This means that calling the operation multiple times
with the same client request token has no effect. By using the idempotent operation, you
can retry a CreateFileSystem
operation without the risk of creating an
extra file system. This approach can be useful when an initial call fails in a way that
makes it unclear whether a file system was created. Examples are if a transport-level
timeout occurred, or your connection was reset. If you use the same client request token
and the initial call created a file system, the client receives a success message as
long as the parameters are the same.
The CreateFileSystem
call returns while the file system's lifecycle
state is still CREATING
. You can check the file-system creation status
by calling the DescribeFileSystems operation, which returns the file system state
along with other information.
createFileSystemFromBackup(_:logger:on:)
public func createFileSystemFromBackup(_ input: CreateFileSystemFromBackupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateFileSystemFromBackupResponse>
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.
<p>If a file system with the specified client request token exists and the parameters
match, this operation returns the description of the file system. If a file system
with the specified client request token exists but the parameters don't match, this
call returns <code>IncompatibleParameterError</code>. If a file system with the
specified client request token doesn't exist, this operation does the following:</p>
<ul>
<li>
<p>Creates a new Amazon FSx file system from backup with an assigned ID,
and an initial lifecycle state of <code>CREATING</code>.</p>
</li>
<li>
<p>Returns the description of the file system.</p>
</li>
</ul>
<p>Parameters like the Active Directory, default share name, automatic backup, and backup
settings default to the parameters of the file system that was backed up, unless
overridden. You can explicitly supply other settings.</p>
<p>By using the idempotent operation, you can retry a
<code>CreateFileSystemFromBackup</code> call without the risk of creating an extra
file system. This approach can be useful when an initial call fails in a way that makes
it unclear whether a file system was created. Examples are if a transport level timeout
occurred, or your connection was reset. If you use the same client request token and the
initial call created a file system, the client receives a success message as long as the
parameters are the same.</p>
<note>
<p>The <code>CreateFileSystemFromBackup</code> call returns while the file system's
lifecycle state is still <code>CREATING</code>. You can check the file-system
creation status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">
DescribeFileSystems</a> operation, which returns the file system state along
with other information.</p>
</note>
createSnapshot(_:logger:on:)
public func createSnapshot(_ input: CreateSnapshotRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateSnapshotResponse>
Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.
If a snapshot with the specified client request token exists, and the parameters
match, this operation returns the description of the existing snapshot. If a snapshot
with the specified client request token exists, and the parameters don't match, this
operation returns IncompatibleParameterError
. If a snapshot with the
specified client request token doesn't exist, CreateSnapshot
does the
following:
-
Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of
CREATING
. -
Returns the description of the snapshot.
By using the idempotent operation, you can retry a CreateSnapshot
operation without the risk of creating an extra snapshot. This approach can be useful
when an initial call fails in a way that makes it unclear whether a snapshot was
created. If you use the same client request token and the initial call created a
snapshot, the operation returns a successful result because all the parameters are the
same.
The CreateSnapshot
operation returns while the snapshot's lifecycle state
is still CREATING
. You can check the snapshot creation status by calling
the DescribeSnapshots operation, which returns the snapshot state along with
other information.
createStorageVirtualMachine(_:logger:on:)
public func createStorageVirtualMachine(_ input: CreateStorageVirtualMachineRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateStorageVirtualMachineResponse>
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
createVolume(_:logger:on:)
public func createVolume(_ input: CreateVolumeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateVolumeResponse>
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
createVolumeFromBackup(_:logger:on:)
public func createVolumeFromBackup(_ input: CreateVolumeFromBackupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateVolumeFromBackupResponse>
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
deleteBackup(_:logger:on:)
public func deleteBackup(_ input: DeleteBackupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteBackupResponse>
Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup
call returns instantly. The backup won't show up in
later DescribeBackups
calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
deleteDataRepositoryAssociation(_:logger:on:)
public func deleteDataRepositoryAssociation(_ input: DeleteDataRepositoryAssociationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDataRepositoryAssociationResponse>
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 only for file systems with the
Persistent_2
deployment type.
deleteFileSystem(_:logger:on:)
public func deleteFileSystem(_ input: DeleteFileSystemRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteFileSystemResponse>
Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the
volumes and storage virtual machines (SVMs) on the file system. Then provide a
FileSystemId
value to the DeleFileSystem
operation.
<p>By default, when you delete an Amazon FSx for Windows File Server file system,
a final backup is created upon deletion. This final backup isn't subject to the file
system's retention policy, and must be manually deleted.</p>
<p>The <code>DeleteFileSystem</code> operation returns while the file system has the
<code>DELETING</code> status. You can check the file system deletion status by
calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">DescribeFileSystems</a> operation, which returns a list of file systems in your
account. If you pass the file system ID for a deleted file system, the
<code>DescribeFileSystems</code> operation returns a <code>FileSystemNotFound</code>
error.</p>
<note>
<p>If a data repository task is in a <code>PENDING</code> or <code>EXECUTING</code> state,
deleting an Amazon FSx for Lustre file system will fail with an HTTP status
code 400 (Bad Request).</p>
</note>
<important>
<p>The data in a deleted file system is also deleted and can't be recovered by
any means.</p>
</important>
deleteSnapshot(_:logger:on:)
public func deleteSnapshot(_ input: DeleteSnapshotRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteSnapshotResponse>
Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.
The DeleteSnapshot
operation returns instantly. The snapshot appears with
the lifecycle status of DELETING
until the deletion is complete.
deleteStorageVirtualMachine(_:logger:on:)
public func deleteStorageVirtualMachine(_ input: DeleteStorageVirtualMachineRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteStorageVirtualMachineResponse>
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.
deleteVolume(_:logger:on:)
public func deleteVolume(_ input: DeleteVolumeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteVolumeResponse>
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
describeBackups(_:logger:on:)
public func describeBackups(_ input: DescribeBackupsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeBackupsResponse>
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.
When retrieving all backups, you can optionally specify the MaxResults
parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken
value in the response. In this case,
send a later request with the NextToken
request parameter set to the value
of the NextToken
value from the last response.
This operation is used in an iterative process to retrieve a list of your backups.
DescribeBackups
is called first without a NextToken
value.
Then the operation continues to be called with the NextToken
parameter set
to the value of the last NextToken
value until a response has no
NextToken
value.
When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResults
value of backup descriptions while still including aNextToken
value. -
The order of the backups returned in the response of one
DescribeBackups
call and the order of the backups returned across the responses of a multi-call iteration is unspecified.
describeDataRepositoryAssociations(_:logger:on:)
public func describeDataRepositoryAssociations(_ input: DescribeDataRepositoryAssociationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDataRepositoryAssociationsResponse>
Returns the description of specific Amazon FSx for Lustre 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 only
for file systems with the Persistent_2
deployment type.
<p>You can use filters to narrow the response to include just data repository
associations for specific file systems (use the <code>file-system-id</code> filter with
the ID of the file system) or data repository associations for a specific repository type
(use the <code>data-repository-type</code> filter with a value of <code>S3</code>).
If you don't use filters, the response returns all data repository associations
owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint
that you're calling.</p>
<p>When retrieving all data repository associations, you can paginate the response by using
the optional <code>MaxResults</code> parameter to limit the number of data repository associations
returned in a response. If more data repository associations remain, Amazon FSx returns a
<code>NextToken</code> value in the response. In this case, send a later
request with the <code>NextToken</code> request parameter set to the value of
<code>NextToken</code> from the last response.</p>
describeDataRepositoryTasks(_:logger:on:)
public func describeDataRepositoryTasks(_ input: DescribeDataRepositoryTasksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDataRepositoryTasksResponse>
Returns the description of specific Amazon FSx for Lustre 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 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.
<p>When retrieving all tasks, you can paginate the response by using the optional <code>MaxResults</code>
parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon
FSx returns a <code>NextToken</code> value in the response. In this case, send a later
request with the <code>NextToken</code> request parameter set to the value of
<code>NextToken</code> from the last response.</p>
describeFileSystemAliases(_:logger:on:)
public func describeFileSystemAliases(_ input: DescribeFileSystemAliasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeFileSystemAliasesResponse>
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
describeFileSystems(_:logger:on:)
public func describeFileSystems(_ input: DescribeFileSystemsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeFileSystemsResponse>
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.
When retrieving all file system descriptions, you can optionally specify the
MaxResults
parameter to limit the number of descriptions in a response.
If more file system descriptions remain, Amazon FSx returns a
NextToken
value in the response. In this case, send a later request
with the NextToken
request parameter set to the value of
NextToken
from the last response.
This operation is used in an iterative process to retrieve a list of your file system
descriptions. DescribeFileSystems
is called first without a
NextToken
value. Then the operation continues to be called with the
NextToken
parameter set to the value of the last NextToken
value until a response has no NextToken
.
When using this operation, keep the following in mind:
-
The implementation might return fewer than
MaxResults
file system descriptions while still including aNextToken
value. -
The order of file systems returned in the response of one
DescribeFileSystems
call and the order of file systems returned across the responses of a multicall iteration is unspecified.
describeSnapshots(_:logger:on:)
public func describeSnapshots(_ input: DescribeSnapshotsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeSnapshotsResponse>
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a
SnapshotIds
value is provided. Otherwise, this operation returns all
snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of
the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults
parameter to limit the number of snapshots in a response. If more backups remain,
Amazon FSx returns a NextToken
value in the response. In this
case, send a later request with the NextToken
request parameter set to the
value of NextToken
from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots.
DescribeSnapshots
is called first without a NextToken
value. Then the operation continues to be called with the NextToken
parameter set to the value of the last NextToken
value until a response has
no NextToken
value.
When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResults
value of snapshot descriptions while still including aNextToken
value. -
The order of snapshots returned in the response of one
DescribeSnapshots
call and the order of backups returned across the responses of a multi-call iteration is unspecified.
describeStorageVirtualMachines(_:logger:on:)
public func describeStorageVirtualMachines(_ input: DescribeStorageVirtualMachinesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeStorageVirtualMachinesResponse>
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
describeVolumes(_:logger:on:)
public func describeVolumes(_ input: DescribeVolumesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeVolumesResponse>
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
disassociateFileSystemAliases(_:logger:on:)
public func disassociateFileSystemAliases(_ input: DisassociateFileSystemAliasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DisassociateFileSystemAliasesResponse>
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 a 400 Bad Request. For more information, see Working with DNS Aliases.
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
When retrieving all tags, you can optionally specify the MaxResults
parameter to limit the number of tags in a response. If more tags remain, Amazon FSx
returns a NextToken
value in the response. In this case, send a later
request with the NextToken
request parameter set to the value of
NextToken
from the last response.
This action is used in an iterative process to retrieve a list of your tags.
ListTagsForResource
is called first without a
NextToken
value. Then the action continues to be called with the
NextToken
parameter set to the value of the last NextToken
value until a response has no NextToken
.
When using this action, keep the following in mind:
-
The implementation might return fewer than
MaxResults
file system descriptions while still including aNextToken
value. -
The order of tags returned in the response of one
ListTagsForResource
call and the order of tags returned across the responses of a multi-call iteration is unspecified.
releaseFileSystemNfsV3Locks(_:logger:on:)
public func releaseFileSystemNfsV3Locks(_ input: ReleaseFileSystemNfsV3LocksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ReleaseFileSystemNfsV3LocksResponse>
Releases the file system lock from an Amazon FSx for OpenZFS file system.
restoreVolumeFromSnapshot(_:logger:on:)
public func restoreVolumeFromSnapshot(_ input: RestoreVolumeFromSnapshotRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RestoreVolumeFromSnapshotResponse>
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
tagResource(_:logger:on:)
public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TagResourceResponse>
Tags an Amazon FSx resource.
untagResource(_:logger:on:)
public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UntagResourceResponse>
This action removes a tag from an Amazon FSx resource.
updateDataRepositoryAssociation(_:logger:on:)
public func updateDataRepositoryAssociation(_ input: UpdateDataRepositoryAssociationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateDataRepositoryAssociationResponse>
Updates the configuration of an existing data repository association
on an Amazon FSx for Lustre file system. Data repository associations are
supported only for file systems with the Persistent_2
deployment type.
updateFileSystem(_:logger:on:)
public func updateFileSystem(_ input: UpdateFileSystemRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateFileSystemResponse>
Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For Amazon FSx for Windows File Server file systems, you can update the following properties:
-
AuditLogConfiguration
-
AutomaticBackupRetentionDays
-
DailyAutomaticBackupStartTime
-
SelfManagedActiveDirectoryConfiguration
-
StorageCapacity
-
ThroughputCapacity
-
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
-
AutoImportPolicy
-
AutomaticBackupRetentionDays
-
DailyAutomaticBackupStartTime
-
DataCompressionType
-
StorageCapacity
-
WeeklyMaintenanceStartTime
For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:
-
AutomaticBackupRetentionDays
-
DailyAutomaticBackupStartTime
-
DiskIopsConfiguration
-
FsxAdminPassword
-
StorageCapacity
-
ThroughputCapacity
-
WeeklyMaintenanceStartTime
For the Amazon FSx for OpenZFS file systems, you can update the following properties:
-
AutomaticBackupRetentionDays
-
CopyTagsToBackups
-
CopyTagsToVolumes
-
DailyAutomaticBackupStartTime
-
ThroughputCapacity
-
WeeklyMaintenanceStartTime
updateSnapshot(_:logger:on:)
public func updateSnapshot(_ input: UpdateSnapshotRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateSnapshotResponse>
Updates the name of an Amazon FSx for OpenZFS snapshot.
updateStorageVirtualMachine(_:logger:on:)
public func updateStorageVirtualMachine(_ input: UpdateStorageVirtualMachineRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateStorageVirtualMachineResponse>
Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
updateVolume(_:logger:on:)
public func updateVolume(_ input: UpdateVolumeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateVolumeResponse>
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
describeBackupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeBackupsPaginator( _ input: DescribeBackupsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeBackupsRequest, DescribeBackupsResponse>
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.When retrieving all backups, you can optionally specify the
MaxResults
parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns aNextToken
value in the response. In this case, send a later request with theNextToken
request parameter set to the value of theNextToken
value from the last response.This operation is used in an iterative process to retrieve a list of your backups.
DescribeBackups
is called first without aNextToken
value. Then the operation continues to be called with theNextToken
parameter set to the value of the lastNextToken
value until a response has noNextToken
value.When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResults
value of backup descriptions while still including aNextToken
value. -
The order of the backups returned in the response of one
DescribeBackups
call and the order of the backups returned across the responses of a multi-call iteration is unspecified.
-
describeDataRepositoryAssociationsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Return PaginatorSequence for operation.
public func describeDataRepositoryAssociationsPaginator( _ input: DescribeDataRepositoryAssociationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDataRepositoryAssociationsRequest, DescribeDataRepositoryAssociationsResponse>
Returns the description of specific Amazon FSx for Lustre 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 only for file systems with thePersistent_2
deployment type.<p>You can use filters to narrow the response to include just data repository associations for specific file systems (use the <code>file-system-id</code> filter with the ID of the file system) or data repository associations for a specific repository type (use the <code>data-repository-type</code> filter with a value of <code>S3</code>). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.</p> <p>When retrieving all data repository associations, you can paginate the response by using the optional <code>MaxResults</code> parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response.</p>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeDataRepositoryTasksPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Return PaginatorSequence for operation.
public func describeDataRepositoryTasksPaginator( _ input: DescribeDataRepositoryTasksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeDataRepositoryTasksRequest, DescribeDataRepositoryTasksResponse>
Returns the description of specific Amazon FSx for Lustre 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 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.<p>When retrieving all tasks, you can paginate the response by using the optional <code>MaxResults</code> parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response.</p>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeFileSystemAliasesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeFileSystemAliasesPaginator( _ input: DescribeFileSystemAliasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeFileSystemAliasesRequest, DescribeFileSystemAliasesResponse>
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeFileSystemsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeFileSystemsPaginator( _ input: DescribeFileSystemsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeFileSystemsRequest, DescribeFileSystemsResponse>
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.When retrieving all file system descriptions, you can optionally specify the
MaxResults
parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns aNextToken
value in the response. In this case, send a later request with theNextToken
request parameter set to the value ofNextToken
from the last response.This operation is used in an iterative process to retrieve a list of your file system descriptions.
DescribeFileSystems
is called first without aNextToken
value. Then the operation continues to be called with theNextToken
parameter set to the value of the lastNextToken
value until a response has noNextToken
.When using this operation, keep the following in mind:
-
The implementation might return fewer than
MaxResults
file system descriptions while still including aNextToken
value. -
The order of file systems returned in the response of one
DescribeFileSystems
call and the order of file systems returned across the responses of a multicall iteration is unspecified.
-
describeSnapshotsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeSnapshotsPaginator( _ input: DescribeSnapshotsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeSnapshotsRequest, DescribeSnapshotsResponse>
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a
SnapshotIds
value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.When retrieving all snapshots, you can optionally specify the
MaxResults
parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns aNextToken
value in the response. In this case, send a later request with theNextToken
request parameter set to the value ofNextToken
from the last response.Use this operation in an iterative process to retrieve a list of your snapshots.
DescribeSnapshots
is called first without aNextToken
value. Then the operation continues to be called with theNextToken
parameter set to the value of the lastNextToken
value until a response has noNextToken
value.When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResults
value of snapshot descriptions while still including aNextToken
value. -
The order of snapshots returned in the response of one
DescribeSnapshots
call and the order of backups returned across the responses of a multi-call iteration is unspecified.
-
describeStorageVirtualMachinesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeStorageVirtualMachinesPaginator( _ input: DescribeStorageVirtualMachinesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeStorageVirtualMachinesRequest, DescribeStorageVirtualMachinesResponse>
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeVolumesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeVolumesPaginator( _ input: DescribeVolumesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeVolumesRequest, DescribeVolumesResponse>
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listTagsForResourcePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listTagsForResourcePaginator( _ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListTagsForResourceRequest, ListTagsForResourceResponse>
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
When retrieving all tags, you can optionally specify the
MaxResults
parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns aNextToken
value in the response. In this case, send a later request with theNextToken
request parameter set to the value ofNextToken
from the last response.This action is used in an iterative process to retrieve a list of your tags.
ListTagsForResource
is called first without aNextToken
value. Then the action continues to be called with theNextToken
parameter set to the value of the lastNextToken
value until a response has noNextToken
.When using this action, keep the following in mind:
-
The implementation might return fewer than
MaxResults
file system descriptions while still including aNextToken
value. -
The order of tags returned in the response of one
ListTagsForResource
call and the order of tags returned across the responses of a multi-call iteration is unspecified.
-
describeBackupsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeBackupsPaginator<Result>(
_ input: DescribeBackupsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeBackupsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
When retrieving all backups, you can optionally specify the MaxResults
parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken
value in the response. In this case,
send a later request with the NextToken
request parameter set to the value
of the NextToken
value from the last response.
This operation is used in an iterative process to retrieve a list of your backups.
DescribeBackups
is called first without a NextToken
value.
Then the operation continues to be called with the NextToken
parameter set
to the value of the last NextToken
value until a response has no
NextToken
value.
When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResults
value of backup descriptions while still including aNextToken
value. -
The order of the backups returned in the response of one
DescribeBackups
call and the order of the backups returned across the responses of a multi-call iteration is unspecified.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeBackupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeBackupsPaginator(
_ input: DescribeBackupsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeBackupsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
describeDataRepositoryAssociationsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeDataRepositoryAssociationsPaginator<Result>(
_ input: DescribeDataRepositoryAssociationsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeDataRepositoryAssociationsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the description of specific Amazon FSx for Lustre 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 only
for file systems with the Persistent_2
deployment type.
<p>You can use filters to narrow the response to include just data repository
associations for specific file systems (use the <code>file-system-id</code> filter with
the ID of the file system) or data repository associations for a specific repository type
(use the <code>data-repository-type</code> filter with a value of <code>S3</code>).
If you don't use filters, the response returns all data repository associations
owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint
that you're calling.</p>
<p>When retrieving all data repository associations, you can paginate the response by using
the optional <code>MaxResults</code> parameter to limit the number of data repository associations
returned in a response. If more data repository associations remain, Amazon FSx returns a
<code>NextToken</code> value in the response. In this case, send a later
request with the <code>NextToken</code> request parameter set to the value of
<code>NextToken</code> from the last response.</p>
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeDataRepositoryAssociationsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeDataRepositoryAssociationsPaginator(
_ input: DescribeDataRepositoryAssociationsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeDataRepositoryAssociationsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
describeDataRepositoryTasksPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeDataRepositoryTasksPaginator<Result>(
_ input: DescribeDataRepositoryTasksRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeDataRepositoryTasksResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the description of specific Amazon FSx for Lustre 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 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.
<p>When retrieving all tasks, you can paginate the response by using the optional <code>MaxResults</code>
parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon
FSx returns a <code>NextToken</code> value in the response. In this case, send a later
request with the <code>NextToken</code> request parameter set to the value of
<code>NextToken</code> from the last response.</p>
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeDataRepositoryTasksPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeDataRepositoryTasksPaginator(
_ input: DescribeDataRepositoryTasksRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeDataRepositoryTasksResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
describeFileSystemAliasesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeFileSystemAliasesPaginator<Result>(
_ input: DescribeFileSystemAliasesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeFileSystemAliasesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeFileSystemAliasesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeFileSystemAliasesPaginator(
_ input: DescribeFileSystemAliasesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeFileSystemAliasesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
describeFileSystemsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeFileSystemsPaginator<Result>(
_ input: DescribeFileSystemsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeFileSystemsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
When retrieving all file system descriptions, you can optionally specify the
MaxResults
parameter to limit the number of descriptions in a response.
If more file system descriptions remain, Amazon FSx returns a
NextToken
value in the response. In this case, send a later request
with the NextToken
request parameter set to the value of
NextToken
from the last response.
This operation is used in an iterative process to retrieve a list of your file system
descriptions. DescribeFileSystems
is called first without a
NextToken
value. Then the operation continues to be called with the
NextToken
parameter set to the value of the last NextToken
value until a response has no NextToken
.
When using this operation, keep the following in mind:
-
The implementation might return fewer than
MaxResults
file system descriptions while still including aNextToken
value. -
The order of file systems returned in the response of one
DescribeFileSystems
call and the order of file systems returned across the responses of a multicall iteration is unspecified.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeFileSystemsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeFileSystemsPaginator(
_ input: DescribeFileSystemsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeFileSystemsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
describeSnapshotsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeSnapshotsPaginator<Result>(
_ input: DescribeSnapshotsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeSnapshotsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a
SnapshotIds
value is provided. Otherwise, this operation returns all
snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of
the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults
parameter to limit the number of snapshots in a response. If more backups remain,
Amazon FSx returns a NextToken
value in the response. In this
case, send a later request with the NextToken
request parameter set to the
value of NextToken
from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots.
DescribeSnapshots
is called first without a NextToken
value. Then the operation continues to be called with the NextToken
parameter set to the value of the last NextToken
value until a response has
no NextToken
value.
When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResults
value of snapshot descriptions while still including aNextToken
value. -
The order of snapshots returned in the response of one
DescribeSnapshots
call and the order of backups returned across the responses of a multi-call iteration is unspecified.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeSnapshotsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeSnapshotsPaginator(
_ input: DescribeSnapshotsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeSnapshotsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
describeStorageVirtualMachinesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeStorageVirtualMachinesPaginator<Result>(
_ input: DescribeStorageVirtualMachinesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeStorageVirtualMachinesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeStorageVirtualMachinesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeStorageVirtualMachinesPaginator(
_ input: DescribeStorageVirtualMachinesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeStorageVirtualMachinesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
describeVolumesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func describeVolumesPaginator<Result>(
_ input: DescribeVolumesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeVolumesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeVolumesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeVolumesPaginator(
_ input: DescribeVolumesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeVolumesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listTagsForResourcePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listTagsForResourcePaginator<Result>(
_ input: ListTagsForResourceRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListTagsForResourceResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
When retrieving all tags, you can optionally specify the MaxResults
parameter to limit the number of tags in a response. If more tags remain, Amazon FSx
returns a NextToken
value in the response. In this case, send a later
request with the NextToken
request parameter set to the value of
NextToken
from the last response.
This action is used in an iterative process to retrieve a list of your tags.
ListTagsForResource
is called first without a
NextToken
value. Then the action continues to be called with the
NextToken
parameter set to the value of the last NextToken
value until a response has no NextToken
.
When using this action, keep the following in mind:
-
The implementation might return fewer than
MaxResults
file system descriptions while still including aNextToken
value. -
The order of tags returned in the response of one
ListTagsForResource
call and the order of tags returned across the responses of a multi-call iteration is unspecified.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listTagsForResourcePaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listTagsForResourcePaginator(
_ input: ListTagsForResourceRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListTagsForResourceResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.