Class: Aws::FSx::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::FSx::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-fsx/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_backup(params = {}) ⇒ Types::CreateBackupResponse
Creates a backup of an existing Amazon FSx for Windows File Server file system.
-
#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 for Windows File Server backup.
-
#delete_backup(params = {}) ⇒ Types::DeleteBackupResponse
Deletes an Amazon FSx for Windows File Server 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 for Windows File Server backups, if a ‘BackupIds` value is provided for that backup.
-
#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.
-
#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
Updates a file system configuration.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
212 213 214 |
# File 'lib/aws-sdk-fsx/client.rb', line 212 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1584 1585 1586 |
# File 'lib/aws-sdk-fsx/client.rb', line 1584 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1587 1588 1589 |
# File 'lib/aws-sdk-fsx/client.rb', line 1587 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 |
# File 'lib/aws-sdk-fsx/client.rb', line 1562 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-fsx' context[:gem_version] = '1.1.0' Seahorse::Client::Request.new(handlers, context) end |
#create_backup(params = {}) ⇒ Types::CreateBackupResponse
Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.
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 ‘CreateFileSystem` operation returns while the backup’s lifecycle state is still ‘CREATING`. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
<note markdown=“1”>
</note>
377 378 379 380 |
# File 'lib/aws-sdk-fsx/client.rb', line 377 def create_backup(params = {}, = {}) req = build_request(:create_backup, 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.
<note markdown=“1”> 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.
</note>
604 605 606 607 |
# File 'lib/aws-sdk-fsx/client.rb', line 604 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 for Windows File Server backup.
If a file system with the specified client request token exists and the parameters match, this call returns the description of the existing 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.
<note markdown=“1”> The ‘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.
</note>
797 798 799 800 |
# File 'lib/aws-sdk-fsx/client.rb', line 797 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 for Windows File Server 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.
859 860 861 862 |
# File 'lib/aws-sdk-fsx/client.rb', line 859 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.
The data in a deleted file system is also deleted and can’t be recovered by any means.
948 949 950 951 |
# File 'lib/aws-sdk-fsx/client.rb', line 948 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 for Windows File Server 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 a `NextToken` 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.
1108 1109 1110 1111 |
# File 'lib/aws-sdk-fsx/client.rb', line 1108 def describe_backups(params = {}, = {}) req = build_request(:describe_backups, 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 a `NextToken` 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.
1252 1253 1254 1255 |
# File 'lib/aws-sdk-fsx/client.rb', line 1252 def describe_file_systems(params = {}, = {}) req = build_request(:describe_file_systems, 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 a `NextToken` 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.
1339 1340 1341 1342 |
# File 'lib/aws-sdk-fsx/client.rb', line 1339 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags an Amazon FSx resource.
1387 1388 1389 1390 |
# File 'lib/aws-sdk-fsx/client.rb', line 1387 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.
1426 1427 1428 1429 |
# File 'lib/aws-sdk-fsx/client.rb', line 1426 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_file_system(params = {}) ⇒ Types::UpdateFileSystemResponse
Updates a file system configuration.
1553 1554 1555 1556 |
# File 'lib/aws-sdk-fsx/client.rb', line 1553 def update_file_system(params = {}, = {}) req = build_request(:update_file_system, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1577 1578 1579 |
# File 'lib/aws-sdk-fsx/client.rb', line 1577 def waiter_names [] end |