@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonFSx extends Object implements AmazonFSx
AmazonFSx. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
CreateBackupResult |
createBackup(CreateBackupRequest request)
Creates a backup of an existing Amazon FSx for Windows File Server file system.
|
CreateFileSystemResult |
createFileSystem(CreateFileSystemRequest request)
Creates a new, empty Amazon FSx file system.
|
CreateFileSystemFromBackupResult |
createFileSystemFromBackup(CreateFileSystemFromBackupRequest request)
Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
|
DeleteBackupResult |
deleteBackup(DeleteBackupRequest request)
Deletes an Amazon FSx for Windows File Server backup, deleting its contents.
|
DeleteFileSystemResult |
deleteFileSystem(DeleteFileSystemRequest request)
Deletes a file system, deleting its contents.
|
DescribeBackupsResult |
describeBackups(DescribeBackupsRequest request)
Returns the description of specific Amazon FSx for Windows File Server backups, if a
BackupIds value
is provided for that backup. |
DescribeFileSystemsResult |
describeFileSystems(DescribeFileSystemsRequest request)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Tags an Amazon FSx resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
This action removes a tag from an Amazon FSx resource.
|
UpdateFileSystemResult |
updateFileSystem(UpdateFileSystemRequest request)
Updates a file system configuration.
|
public CreateBackupResult createBackup(CreateBackupRequest request)
AmazonFSxCreates 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.
createBackup in interface AmazonFSxrequest - The request object for the CreateBackup operation.public CreateFileSystemResult createFileSystem(CreateFileSystemRequest request)
AmazonFSxCreates 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.
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.
createFileSystem in interface AmazonFSxrequest - The request object for the CreateFileSystem operation.public CreateFileSystemFromBackupResult createFileSystemFromBackup(CreateFileSystemFromBackupRequest request)
AmazonFSxCreates 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.
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.
createFileSystemFromBackup in interface AmazonFSxrequest - The request object for the CreateFileSystemFromBackup operation.public DeleteBackupResult deleteBackup(DeleteBackupRequest request)
AmazonFSxDeletes 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.
deleteBackup in interface AmazonFSxrequest - The request object for DeleteBackup operation.public DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest request)
AmazonFSxDeletes 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.
deleteFileSystem in interface AmazonFSxrequest - The request object for DeleteFileSystem operation.public DescribeBackupsResult describeBackups(DescribeBackupsRequest request)
AmazonFSx
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 NextTokenvalue. 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.
describeBackups in interface AmazonFSxrequest - The request object for DescribeBackups operation.public DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest request)
AmazonFSx
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 NextTokenvalue. 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.
describeFileSystems in interface AmazonFSxrequest - The request object for DescribeFileSystems operation.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonFSxLists 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 NextTokenvalue. 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.
listTagsForResource in interface AmazonFSxrequest - The request object for ListTagsForResource operation.public TagResourceResult tagResource(TagResourceRequest request)
AmazonFSxTags an Amazon FSx resource.
tagResource in interface AmazonFSxrequest - The request object for the TagResource operation.public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonFSxThis action removes a tag from an Amazon FSx resource.
untagResource in interface AmazonFSxrequest - The request object for UntagResource action.public UpdateFileSystemResult updateFileSystem(UpdateFileSystemRequest request)
AmazonFSxUpdates a file system configuration.
updateFileSystem in interface AmazonFSxrequest - The request object for the UpdateFileSystem operation.public void shutdown()
AmazonFSxpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonFSxResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonFSxrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.