Class: Aws::FSx::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::FSx::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb
Overview
An API client for FSx. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::FSx::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_file_system_aliases(params = {}) ⇒ Types::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.
-
#cancel_data_repository_task(params = {}) ⇒ Types::CancelDataRepositoryTaskResponse
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
PENDING
orEXECUTING
state. -
#create_backup(params = {}) ⇒ Types::CreateBackupResponse
Creates a backup of an existing Amazon FSx file system.
-
#create_data_repository_task(params = {}) ⇒ Types::CreateDataRepositoryTaskResponse
Creates an Amazon FSx for Lustre data repository task.
-
#create_file_system(params = {}) ⇒ Types::CreateFileSystemResponse
Creates a new, empty Amazon FSx file system.
-
#create_file_system_from_backup(params = {}) ⇒ Types::CreateFileSystemFromBackupResponse
Creates a new Amazon FSx file system from an existing Amazon FSx backup.
-
#delete_backup(params = {}) ⇒ Types::DeleteBackupResponse
Deletes an Amazon FSx backup, deleting its contents.
-
#delete_file_system(params = {}) ⇒ Types::DeleteFileSystemResponse
Deletes a file system, deleting its contents.
-
#describe_backups(params = {}) ⇒ Types::DescribeBackupsResponse
Returns the description of specific Amazon FSx backups, if a
BackupIds
value is provided for that backup. -
#describe_data_repository_tasks(params = {}) ⇒ Types::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. -
#describe_file_system_aliases(params = {}) ⇒ Types::DescribeFileSystemAliasesResponse
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
-
#describe_file_systems(params = {}) ⇒ Types::DescribeFileSystemsResponse
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds
value is provided for that file system. -
#disassociate_file_system_aliases(params = {}) ⇒ Types::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.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
-
#tag_resource(params = {}) ⇒ Struct
Tags an Amazon FSx resource.
-
#untag_resource(params = {}) ⇒ Struct
This action removes a tag from an Amazon FSx resource.
-
#update_file_system(params = {}) ⇒ Types::UpdateFileSystemResponse
Use this operation to update the configuration of an existing Amazon FSx file system.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#associate_file_system_aliases(params = {}) ⇒ Types::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 systen 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.
415 416 417 418 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 415 def associate_file_system_aliases(params = {}, = {}) req = build_request(:associate_file_system_aliases, params) req.send_request() end |
#cancel_data_repository_task(params = {}) ⇒ Types::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.
454 455 456 457 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 454 def cancel_data_repository_task(params = {}, = {}) req = build_request(:cancel_data_repository_task, params) req.send_request() end |
#create_backup(params = {}) ⇒ Types::CreateBackupResponse
Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:
a Persistent deployment type
is not linked to a data respository.
For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups.
For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows backups.
If a backup with the specified client request token exists, and the
parameters match, this operation returns the description of the
existing backup. If a backup specified client request token exists,
and the parameters don't match, this operation returns
IncompatibleParameterError
. If a backup with the specified client
request token doesn't exist, CreateBackup
does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of
CREATING
.Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup
operation without the risk of creating an extra backup. This approach
can be useful when an initial call fails in a way that makes it
unclear whether a backup was created. If you use the same client
request token and the initial call created a backup, the operation
returns a successful result because all the parameters are the same.
The CreateBackup
operation returns while the backup's lifecycle
state is still CREATING
. You can check the backup creation status by
calling the DescribeBackups operation, which returns the backup state
along with other information.
667 668 669 670 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 667 def create_backup(params = {}, = {}) req = build_request(:create_backup, params) req.send_request() end |
#create_data_repository_task(params = {}) ⇒ Types::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 repository. 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 its 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.
781 782 783 784 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 781 def create_data_repository_task(params = {}, = {}) req = build_request(:create_data_repository_task, params) req.send_request() end |
#create_file_system(params = {}) ⇒ Types::CreateFileSystemResponse
Creates a new, empty Amazon FSx file system.
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 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.
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.
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.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1111 def create_file_system(params = {}, = {}) req = build_request(:create_file_system, params) req.send_request() end |
#create_file_system_from_backup(params = {}) ⇒ Types::CreateFileSystemFromBackupResponse
Creates a new Amazon FSx file system from an existing Amazon FSx backup.
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 client request token specified by the file system
exists and the parameters don't match, this call returns
IncompatibleParameterError
. If a file system with the specified
client request token doesn't exist, this operation does the
following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of
CREATING
.Returns the description of the file system.
Parameters like 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.
By using the idempotent operation, you can retry a
CreateFileSystemFromBackup
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 success as
long as the parameters are the same.
CreateFileSystemFromBackup
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.
1392 1393 1394 1395 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1392 def create_file_system_from_backup(params = {}, = {}) req = build_request(:create_file_system_from_backup, params) req.send_request() end |
#delete_backup(params = {}) ⇒ Types::DeleteBackupResponse
Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup
call returns instantly. The backup will not show up
in later DescribeBackups
calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
1453 1454 1455 1456 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1453 def delete_backup(params = {}, = {}) req = build_request(:delete_backup, params) req.send_request() end |
#delete_file_system(params = {}) ⇒ Types::DeleteFileSystemResponse
Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
The DeleteFileSystem
action returns while the file system has the
DELETING
status. You can check the file system deletion status by
calling the DescribeFileSystems action, which returns a list of file
systems in your account. If you pass the file system ID for a deleted
file system, the DescribeFileSystems returns a FileSystemNotFound
error.
PENDING
or EXECUTING
state.
The data in a deleted file system is also deleted and can't be recovered by any means.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1566 def delete_file_system(params = {}, = {}) req = build_request(:delete_file_system, params) req.send_request() end |
#describe_backups(params = {}) ⇒ Types::DescribeBackupsResponse
Returns the description of specific Amazon FSx backups, if a
BackupIds
value is provided for that backup. Otherwise, it returns
all backups owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all backups, you can optionally specify the
MaxResults
parameter to limit the number of backups in a response.
If more backups remain, Amazon FSx returns a NextToken
value in the
response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken
from the last
response.
This action is used in an iterative process to retrieve a list of your
backups. DescribeBackups
is called first without a NextToken
value.
Then the action continues to be called with the NextToken
parameter
set to the value of the last NextToken
value until a response has no
NextToken
.
When using this action, keep the following in mind:
The implementation might return fewer than
MaxResults
file system descriptions while still including aNextToken
value.The order of backups returned in the response of one
DescribeBackups
call and the order of backups returned across the responses of a multi-call iteration is unspecified.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1759 1760 1761 1762 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1759 def describe_backups(params = {}, = {}) req = build_request(:describe_backups, params) req.send_request() end |
#describe_data_repository_tasks(params = {}) ⇒ Types::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 AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the
optional MaxResults
parameter to limit the number of tasks returned
in a response. If more tasks 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1850 1851 1852 1853 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1850 def describe_data_repository_tasks(params = {}, = {}) req = build_request(:describe_data_repository_tasks, params) req.send_request() end |
#describe_file_system_aliases(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1914 1915 1916 1917 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1914 def describe_file_system_aliases(params = {}, = {}) req = build_request(:describe_file_system_aliases, params) req.send_request() end |
#describe_file_systems(params = {}) ⇒ Types::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 AWS account in
the AWS 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 action 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 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 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2091 2092 2093 2094 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2091 def describe_file_systems(params = {}, = {}) req = build_request(:describe_file_systems, params) req.send_request() end |
#disassociate_file_system_aliases(params = {}) ⇒ Types::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.
2149 2150 2151 2152 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2149 def disassociate_file_system_aliases(params = {}, = {}) req = build_request(:disassociate_file_system_aliases, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::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.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2236 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags an Amazon FSx resource.
2284 2285 2286 2287 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2284 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
This action removes a tag from an Amazon FSx resource.
2323 2324 2325 2326 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2323 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_file_system(params = {}) ⇒ Types::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:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
StorageCapacity
WeeklyMaintenanceStartTime
2556 2557 2558 2559 |
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2556 def update_file_system(params = {}, = {}) req = build_request(:update_file_system, params) req.send_request() end |