All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.fsx.AmazonFSx Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon FSx module holds the client classes that are used for communicating with Amazon FSx Service

There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.fsx;

import javax.annotation.Generated;

import com.amazonaws.*;
import com.amazonaws.regions.*;

import com.amazonaws.services.fsx.model.*;

/**
 * Interface for accessing Amazon FSx.
 * 

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.fsx.AbstractAmazonFSx} instead. *

*

*

* Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use * shared file storage. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonFSx { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "fsx"; /** *

* 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. *

    *
  • *
* * @param cancelDataRepositoryTaskRequest * Cancels a data repository task. * @return Result of the CancelDataRepositoryTask operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws UnsupportedOperationException * The requested operation is not supported for this resource or API. * @throws DataRepositoryTaskNotFoundException * The data repository task or tasks you specified could not be found. * @throws DataRepositoryTaskEndedException * The data repository task could not be canceled because the task has already ended. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @sample AmazonFSx.CancelDataRepositoryTask * @see AWS * API Documentation */ CancelDataRepositoryTaskResult cancelDataRepositoryTask(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest); /** *

* 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. *

* *

* * * @param createBackupRequest * The request object for the CreateBackup operation. * @return Result of the CreateBackup operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws UnsupportedOperationException * The requested operation is not supported for this resource or API. * @throws FileSystemNotFoundException * No Amazon FSx file systems were found based upon supplied parameters. * @throws BackupInProgressException * Another backup is already under way. Wait for completion before initiating additional backups of this * file system. * @throws IncompatibleParameterErrorException * The error returned when a second request is received with the same client request token but different * parameters settings. A client request token should always uniquely identify a single request. * @throws ServiceLimitExceededException * An error indicating that a particular service limit was exceeded. You can increase some service limits by * contacting AWS Support. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @sample AmazonFSx.CreateBackup * @see AWS API * Documentation */ CreateBackupResult createBackup(CreateBackupRequest createBackupRequest); /** *

* 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 Using Data Repository * Tasks. To learn more about linking a data repository to your file system, see Setting the * Export Prefix. *

* * @param createDataRepositoryTaskRequest * @return Result of the CreateDataRepositoryTask operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws UnsupportedOperationException * The requested operation is not supported for this resource or API. * @throws FileSystemNotFoundException * No Amazon FSx file systems were found based upon supplied parameters. * @throws IncompatibleParameterErrorException * The error returned when a second request is received with the same client request token but different * parameters settings. A client request token should always uniquely identify a single request. * @throws ServiceLimitExceededException * An error indicating that a particular service limit was exceeded. You can increase some service limits by * contacting AWS Support. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @throws DataRepositoryTaskExecutingException * An existing data repository task is currently executing on the file system. Wait until the existing task * has completed, then create the new task. * @sample AmazonFSx.CreateDataRepositoryTask * @see AWS * API Documentation */ CreateDataRepositoryTaskResult createDataRepositoryTask(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest); /** *

* 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. *

* *

* 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. *

*
* * @param createFileSystemRequest * The request object used to create a new Amazon FSx file system. * @return Result of the CreateFileSystem operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws ActiveDirectoryErrorException * An Active Directory error. * @throws IncompatibleParameterErrorException * The error returned when a second request is received with the same client request token but different * parameters settings. A client request token should always uniquely identify a single request. * @throws InvalidImportPathException * The path provided for data repository import isn't valid. * @throws InvalidExportPathException * The path provided for data repository export isn't valid. * @throws InvalidNetworkSettingsException * One or more network settings specified in the request are invalid. InvalidVpcId means that * the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the * list of IDs for subnets that are either invalid or not part of the VPC specified. * InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid * or not part of the VPC specified. * @throws InvalidPerUnitStorageThroughputException * An invalid value for PerUnitStorageThroughput was provided. Please create your file system * again, using a valid value. * @throws ServiceLimitExceededException * An error indicating that a particular service limit was exceeded. You can increase some service limits by * contacting AWS Support. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @throws MissingFileSystemConfigurationException * A file system configuration is required for this operation. * @sample AmazonFSx.CreateFileSystem * @see AWS API * Documentation */ CreateFileSystemResult createFileSystem(CreateFileSystemRequest createFileSystemRequest); /** *

* 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 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. *

* *

* 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. *

*
* * @param createFileSystemFromBackupRequest * The request object for the CreateFileSystemFromBackup operation. * @return Result of the CreateFileSystemFromBackup operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws ActiveDirectoryErrorException * An Active Directory error. * @throws IncompatibleParameterErrorException * The error returned when a second request is received with the same client request token but different * parameters settings. A client request token should always uniquely identify a single request. * @throws InvalidNetworkSettingsException * One or more network settings specified in the request are invalid. InvalidVpcId means that * the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the * list of IDs for subnets that are either invalid or not part of the VPC specified. * InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid * or not part of the VPC specified. * @throws ServiceLimitExceededException * An error indicating that a particular service limit was exceeded. You can increase some service limits by * contacting AWS Support. * @throws BackupNotFoundException * No Amazon FSx backups were found based upon the supplied parameters. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @throws MissingFileSystemConfigurationException * A file system configuration is required for this operation. * @sample AmazonFSx.CreateFileSystemFromBackup * @see AWS * API Documentation */ CreateFileSystemFromBackupResult createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest); /** *

* 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. *

*
* * @param deleteBackupRequest * The request object for DeleteBackup operation. * @return Result of the DeleteBackup operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws BackupInProgressException * Another backup is already under way. Wait for completion before initiating additional backups of this * file system. * @throws BackupNotFoundException * No Amazon FSx backups were found based upon the supplied parameters. * @throws BackupRestoringException * You can't delete a backup while it's being used to restore a file system. * @throws IncompatibleParameterErrorException * The error returned when a second request is received with the same client request token but different * parameters settings. A client request token should always uniquely identify a single request. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @sample AmazonFSx.DeleteBackup * @see AWS API * Documentation */ DeleteBackupResult deleteBackup(DeleteBackupRequest deleteBackupRequest); /** *

* 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. *

* *

* Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a * PENDING or EXECUTING state. *

*
*

* The data in a deleted file system is also deleted and can't be recovered by any means. *

*
* * @param deleteFileSystemRequest * The request object for DeleteFileSystem operation. * @return Result of the DeleteFileSystem operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws IncompatibleParameterErrorException * The error returned when a second request is received with the same client request token but different * parameters settings. A client request token should always uniquely identify a single request. * @throws FileSystemNotFoundException * No Amazon FSx file systems were found based upon supplied parameters. * @throws ServiceLimitExceededException * An error indicating that a particular service limit was exceeded. You can increase some service limits by * contacting AWS Support. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @sample AmazonFSx.DeleteFileSystem * @see AWS API * Documentation */ DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest); /** *

* 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. *

    *
  • *
* * @param describeBackupsRequest * The request object for DescribeBackups operation. * @return Result of the DescribeBackups operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws FileSystemNotFoundException * No Amazon FSx file systems were found based upon supplied parameters. * @throws BackupNotFoundException * No Amazon FSx backups were found based upon the supplied parameters. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @sample AmazonFSx.DescribeBackups * @see AWS API * Documentation */ DescribeBackupsResult describeBackups(DescribeBackupsRequest describeBackupsRequest); /** *

* 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. *

* * @param describeDataRepositoryTasksRequest * @return Result of the DescribeDataRepositoryTasks operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws FileSystemNotFoundException * No Amazon FSx file systems were found based upon supplied parameters. * @throws DataRepositoryTaskNotFoundException * The data repository task or tasks you specified could not be found. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @sample AmazonFSx.DescribeDataRepositoryTasks * @see AWS API Documentation */ DescribeDataRepositoryTasksResult describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest); /** *

* 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. *

    *
  • *
* * @param describeFileSystemsRequest * The request object for DescribeFileSystems operation. * @return Result of the DescribeFileSystems operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws FileSystemNotFoundException * No Amazon FSx file systems were found based upon supplied parameters. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @sample AmazonFSx.DescribeFileSystems * @see AWS API * Documentation */ DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest); /** *

* 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 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. *

    *
  • *
* * @param listTagsForResourceRequest * The request object for ListTagsForResource operation. * @return Result of the ListTagsForResource operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @throws ResourceNotFoundException * The resource specified by the Amazon Resource Name (ARN) can't be found. * @throws NotServiceResourceErrorException * The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API * of the relevant service to perform the operation. * @throws ResourceDoesNotSupportTaggingException * The resource specified does not support tagging. * @sample AmazonFSx.ListTagsForResource * @see AWS API * Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Tags an Amazon FSx resource. *

* * @param tagResourceRequest * The request object for the TagResource operation. * @return Result of the TagResource operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @throws ResourceNotFoundException * The resource specified by the Amazon Resource Name (ARN) can't be found. * @throws NotServiceResourceErrorException * The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API * of the relevant service to perform the operation. * @throws ResourceDoesNotSupportTaggingException * The resource specified does not support tagging. * @sample AmazonFSx.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* This action removes a tag from an Amazon FSx resource. *

* * @param untagResourceRequest * The request object for UntagResource action. * @return Result of the UntagResource operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @throws ResourceNotFoundException * The resource specified by the Amazon Resource Name (ARN) can't be found. * @throws NotServiceResourceErrorException * The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API * of the relevant service to perform the operation. * @throws ResourceDoesNotSupportTaggingException * The resource specified does not support tagging. * @sample AmazonFSx.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Updates a file system configuration. *

* * @param updateFileSystemRequest * The request object for the UpdateFileSystem operation. * @return Result of the UpdateFileSystem operation returned by the service. * @throws BadRequestException * A generic error indicating a failure with a client request. * @throws UnsupportedOperationException * The requested operation is not supported for this resource or API. * @throws IncompatibleParameterErrorException * The error returned when a second request is received with the same client request token but different * parameters settings. A client request token should always uniquely identify a single request. * @throws InternalServerErrorException * A generic error indicating a server-side failure. * @throws FileSystemNotFoundException * No Amazon FSx file systems were found based upon supplied parameters. * @throws MissingFileSystemConfigurationException * A file system configuration is required for this operation. * @sample AmazonFSx.UpdateFileSystem * @see AWS API * Documentation */ UpdateFileSystemResult updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy