Interface EfsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EfsAsyncClient extends AwsClient
Service client for accessing EFS asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. Amazon Elastic File System

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so that your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.

  • Field Details

  • Method Details

    • createAccessPoint

      default CompletableFuture<CreateAccessPointResponse> createAccessPoint(CreateAccessPointRequest createAccessPointRequest)

      Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. A file system can have a maximum of 10,000 access points unless you request an increase. To learn more, see Mounting a file system using EFS access points.

      If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit.

      This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

      Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.

      Parameters:
      createAccessPointRequest -
      Returns:
      A Java Future containing the result of the CreateAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • AccessPointAlreadyExistsException Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointLimitExceededException Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.
      • ThrottlingException Returned when the CreateAccessPoint API action is called too quickly and the number of Access Points on the file system is nearing the limit of 120.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPoint

      default CompletableFuture<CreateAccessPointResponse> createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)

      Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. A file system can have a maximum of 10,000 access points unless you request an increase. To learn more, see Mounting a file system using EFS access points.

      If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit.

      This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

      Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.


      This is a convenience which creates an instance of the CreateAccessPointRequest.Builder avoiding the need to create one manually via CreateAccessPointRequest.builder()

      Parameters:
      createAccessPointRequest - A Consumer that will call methods on CreateAccessPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • AccessPointAlreadyExistsException Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointLimitExceededException Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.
      • ThrottlingException Returned when the CreateAccessPoint API action is called too quickly and the number of Access Points on the file system is nearing the limit of 120.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileSystem

      default CompletableFuture<CreateFileSystemResponse> createFileSystem(CreateFileSystemRequest createFileSystemRequest)

      Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following:

      • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

      • Returns with the description of the created file system.

      Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

      For basic use cases, you can use a randomly generated UUID for the creation token.

      The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

      For more information, see Creating a file system in the Amazon EFS User Guide.

      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 among other things returns the file system state.

      This operation accepts an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose PerformanceMode for all file systems. The maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the generalPurpose mode. MaxIO mode is not supported for One Zone file systems or file systems that use Elastic throughput.

      The PerformanceMode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes.

      You can set the throughput mode for the file system using the ThroughputMode parameter.

      After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

      This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

      File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.

      Parameters:
      createFileSystemRequest -
      Returns:
      A Java Future containing the result of the CreateFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemAlreadyExistsException Returned if the file system you are trying to create already exists, with the creation token you provided.
      • FileSystemLimitExceededException Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
      • InsufficientThroughputCapacityException Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
      • ThroughputLimitExceededException Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
      • UnsupportedAvailabilityZoneException Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileSystem

      default CompletableFuture<CreateFileSystemResponse> createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)

      Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following:

      • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

      • Returns with the description of the created file system.

      Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

      For basic use cases, you can use a randomly generated UUID for the creation token.

      The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

      For more information, see Creating a file system in the Amazon EFS User Guide.

      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 among other things returns the file system state.

      This operation accepts an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose PerformanceMode for all file systems. The maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the generalPurpose mode. MaxIO mode is not supported for One Zone file systems or file systems that use Elastic throughput.

      The PerformanceMode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes.

      You can set the throughput mode for the file system using the ThroughputMode parameter.

      After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

      This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

      File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.


      This is a convenience which creates an instance of the CreateFileSystemRequest.Builder avoiding the need to create one manually via CreateFileSystemRequest.builder()

      Parameters:
      createFileSystemRequest - A Consumer that will call methods on CreateFileSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemAlreadyExistsException Returned if the file system you are trying to create already exists, with the creation token you provided.
      • FileSystemLimitExceededException Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
      • InsufficientThroughputCapacityException Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
      • ThroughputLimitExceededException Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
      • UnsupportedAvailabilityZoneException Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMountTarget

      default CompletableFuture<CreateMountTargetResponse> createMountTarget(CreateMountTargetRequest createMountTargetRequest)

      Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.

      You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system.

      You can create only one mount target for a One Zone file system. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target.

      For more information, see Amazon EFS: How it Works.

      To create a mount target for a file system, the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

      In the request, provide the following:

      • The file system ID for which you are creating the mount target.

      • A subnet ID, which determines the following:

        • The VPC in which Amazon EFS creates the mount target

        • The Availability Zone in which Amazon EFS creates the mount target

        • The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

      After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

      Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

      • Must belong to the same VPC as the subnets of the existing mount targets

      • Must not be in the same Availability Zone as any of the subnets of the existing mount targets

      If the request satisfies the requirements, Amazon EFS does the following:

      • Creates a new mount target in the specified subnet.

      • Also creates a new network interface in the subnet as follows:

        • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

        • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

        • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

        • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

        Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

      The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.

      We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS pricing. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.

      This operation requires permissions for the following action on the file system:

      • elasticfilesystem:CreateMountTarget

      This operation also requires permissions for the following Amazon EC2 actions:

      • ec2:DescribeSubnets

      • ec2:DescribeNetworkInterfaces

      • ec2:CreateNetworkInterface

      Parameters:
      createMountTargetRequest -
      Returns:
      A Java Future containing the result of the CreateMountTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • MountTargetConflictException Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.
      • SubnetNotFoundException Returned if there is no subnet with ID SubnetId provided in the request.
      • NoFreeAddressesInSubnetException Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.
      • IpAddressInUseException Returned if the request specified an IpAddress that is already in use in the subnet.
      • NetworkInterfaceLimitExceededException The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).
      • SecurityGroupLimitExceededException Returned if the number of SecurityGroups specified in the request is greater than the limit, which is based on account quota. Either delete some security groups or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table).
      • SecurityGroupNotFoundException Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
      • UnsupportedAvailabilityZoneException Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
      • AvailabilityZonesMismatchException Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMountTarget

      default CompletableFuture<CreateMountTargetResponse> createMountTarget(Consumer<CreateMountTargetRequest.Builder> createMountTargetRequest)

      Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.

      You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system.

      You can create only one mount target for a One Zone file system. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target.

      For more information, see Amazon EFS: How it Works.

      To create a mount target for a file system, the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

      In the request, provide the following:

      • The file system ID for which you are creating the mount target.

      • A subnet ID, which determines the following:

        • The VPC in which Amazon EFS creates the mount target

        • The Availability Zone in which Amazon EFS creates the mount target

        • The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

      After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

      Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

      • Must belong to the same VPC as the subnets of the existing mount targets

      • Must not be in the same Availability Zone as any of the subnets of the existing mount targets

      If the request satisfies the requirements, Amazon EFS does the following:

      • Creates a new mount target in the specified subnet.

      • Also creates a new network interface in the subnet as follows:

        • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

        • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

        • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

        • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

        Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

      The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.

      We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS pricing. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.

      This operation requires permissions for the following action on the file system:

      • elasticfilesystem:CreateMountTarget

      This operation also requires permissions for the following Amazon EC2 actions:

      • ec2:DescribeSubnets

      • ec2:DescribeNetworkInterfaces

      • ec2:CreateNetworkInterface


      This is a convenience which creates an instance of the CreateMountTargetRequest.Builder avoiding the need to create one manually via CreateMountTargetRequest.builder()

      Parameters:
      createMountTargetRequest - A Consumer that will call methods on CreateMountTargetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMountTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • MountTargetConflictException Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.
      • SubnetNotFoundException Returned if there is no subnet with ID SubnetId provided in the request.
      • NoFreeAddressesInSubnetException Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.
      • IpAddressInUseException Returned if the request specified an IpAddress that is already in use in the subnet.
      • NetworkInterfaceLimitExceededException The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).
      • SecurityGroupLimitExceededException Returned if the number of SecurityGroups specified in the request is greater than the limit, which is based on account quota. Either delete some security groups or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table).
      • SecurityGroupNotFoundException Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
      • UnsupportedAvailabilityZoneException Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
      • AvailabilityZonesMismatchException Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createReplicationConfiguration

      default CompletableFuture<CreateReplicationConfigurationResponse> createReplicationConfiguration(CreateReplicationConfigurationRequest createReplicationConfigurationRequest)

      Creates a replication configuration to either a new or existing EFS file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following:

      • Source file system – The EFS file system that you want to replicate.

      • Destination file system – The destination file system to which the source file system is replicated. There can only be one destination file system in a replication configuration.

        A file system can be part of only one replication configuration.

        The destination parameters for the replication configuration depend on whether you are replicating to a new file system or to an existing file system, and if you are replicating across Amazon Web Services accounts. See DestinationToCreate for more information.

      This operation requires permissions for the elasticfilesystem:CreateReplicationConfiguration action. Additionally, other permissions are required depending on how you are replicating file systems. For more information, see Required permissions for replication in the Amazon EFS User Guide.

      Parameters:
      createReplicationConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateReplicationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • ReplicationNotFoundException Returned if the specified file system does not have a replication configuration.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • UnsupportedAvailabilityZoneException Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
      • FileSystemLimitExceededException Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
      • InsufficientThroughputCapacityException Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
      • ThroughputLimitExceededException Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
      • ConflictException Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createReplicationConfiguration

      default CompletableFuture<CreateReplicationConfigurationResponse> createReplicationConfiguration(Consumer<CreateReplicationConfigurationRequest.Builder> createReplicationConfigurationRequest)

      Creates a replication configuration to either a new or existing EFS file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following:

      • Source file system – The EFS file system that you want to replicate.

      • Destination file system – The destination file system to which the source file system is replicated. There can only be one destination file system in a replication configuration.

        A file system can be part of only one replication configuration.

        The destination parameters for the replication configuration depend on whether you are replicating to a new file system or to an existing file system, and if you are replicating across Amazon Web Services accounts. See DestinationToCreate for more information.

      This operation requires permissions for the elasticfilesystem:CreateReplicationConfiguration action. Additionally, other permissions are required depending on how you are replicating file systems. For more information, see Required permissions for replication in the Amazon EFS User Guide.


      This is a convenience which creates an instance of the CreateReplicationConfigurationRequest.Builder avoiding the need to create one manually via CreateReplicationConfigurationRequest.builder()

      Parameters:
      createReplicationConfigurationRequest - A Consumer that will call methods on CreateReplicationConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateReplicationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • ReplicationNotFoundException Returned if the specified file system does not have a replication configuration.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • UnsupportedAvailabilityZoneException Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
      • FileSystemLimitExceededException Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
      • InsufficientThroughputCapacityException Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
      • ThroughputLimitExceededException Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
      • ConflictException Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTags

      @Deprecated default CompletableFuture<CreateTagsResponse> createTags(CreateTagsRequest createTagsRequest)
      Deprecated.
      Use TagResource.

      DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS resources, use the API action.

      Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.

      This operation requires permission for the elasticfilesystem:CreateTags action.

      Parameters:
      createTagsRequest -
      Returns:
      A Java Future containing the result of the CreateTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTags

      @Deprecated default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
      Deprecated.
      Use TagResource.

      DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS resources, use the API action.

      Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.

      This operation requires permission for the elasticfilesystem:CreateTags action.


      This is a convenience which creates an instance of the CreateTagsRequest.Builder avoiding the need to create one manually via CreateTagsRequest.builder()

      Parameters:
      createTagsRequest - A Consumer that will call methods on CreateTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPoint

      default CompletableFuture<DeleteAccessPointResponse> deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)

      Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.

      This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.

      Parameters:
      deleteAccessPointRequest -
      Returns:
      A Java Future containing the result of the DeleteAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPoint

      default CompletableFuture<DeleteAccessPointResponse> deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)

      Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.

      This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.


      This is a convenience which creates an instance of the DeleteAccessPointRequest.Builder avoiding the need to create one manually via DeleteAccessPointRequest.builder()

      Parameters:
      deleteAccessPointRequest - A Consumer that will call methods on DeleteAccessPointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessPoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystem

      default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)

      Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.

      You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.

      You cannot delete a file system that is part of an EFS replication configuration. You need to delete the replication configuration first.

      You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

      The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

      This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

      Parameters:
      deleteFileSystemRequest -
      Returns:
      A Java Future containing the result of the DeleteFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • FileSystemInUseException Returned if a file system has mount targets.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystem

      default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)

      Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.

      You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.

      You cannot delete a file system that is part of an EFS replication configuration. You need to delete the replication configuration first.

      You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

      The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

      This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.


      This is a convenience which creates an instance of the DeleteFileSystemRequest.Builder avoiding the need to create one manually via DeleteFileSystemRequest.builder()

      Parameters:
      deleteFileSystemRequest - A Consumer that will call methods on DeleteFileSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • FileSystemInUseException Returned if a file system has mount targets.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystemPolicy

      default CompletableFuture<DeleteFileSystemPolicyResponse> deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)

      Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS.

      This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.

      Parameters:
      deleteFileSystemPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteFileSystemPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystemPolicy

      default CompletableFuture<DeleteFileSystemPolicyResponse> deleteFileSystemPolicy(Consumer<DeleteFileSystemPolicyRequest.Builder> deleteFileSystemPolicyRequest)

      Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS.

      This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.


      This is a convenience which creates an instance of the DeleteFileSystemPolicyRequest.Builder avoiding the need to create one manually via DeleteFileSystemPolicyRequest.builder()

      Parameters:
      deleteFileSystemPolicyRequest - A Consumer that will call methods on DeleteFileSystemPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFileSystemPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMountTarget

      default CompletableFuture<DeleteMountTargetResponse> deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)

      Deletes the specified mount target.

      This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target.

      This operation requires permissions for the following action on the file system:

      • elasticfilesystem:DeleteMountTarget

      The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

      The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

      • ec2:DeleteNetworkInterface

      Parameters:
      deleteMountTargetRequest -
      Returns:
      A Java Future containing the result of the DeleteMountTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • DependencyTimeoutException The service timed out trying to fulfill the request, and the client should try the call again.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMountTarget

      default CompletableFuture<DeleteMountTargetResponse> deleteMountTarget(Consumer<DeleteMountTargetRequest.Builder> deleteMountTargetRequest)

      Deletes the specified mount target.

      This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target.

      This operation requires permissions for the following action on the file system:

      • elasticfilesystem:DeleteMountTarget

      The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

      The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

      • ec2:DeleteNetworkInterface


      This is a convenience which creates an instance of the DeleteMountTargetRequest.Builder avoiding the need to create one manually via DeleteMountTargetRequest.builder()

      Parameters:
      deleteMountTargetRequest - A Consumer that will call methods on DeleteMountTargetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMountTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • DependencyTimeoutException The service timed out trying to fulfill the request, and the client should try the call again.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteReplicationConfiguration

      default CompletableFuture<DeleteReplicationConfigurationResponse> deleteReplicationConfiguration(DeleteReplicationConfigurationRequest deleteReplicationConfigurationRequest)

      Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.

      This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration action.

      Parameters:
      deleteReplicationConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteReplicationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • ReplicationNotFoundException Returned if the specified file system does not have a replication configuration.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteReplicationConfiguration

      default CompletableFuture<DeleteReplicationConfigurationResponse> deleteReplicationConfiguration(Consumer<DeleteReplicationConfigurationRequest.Builder> deleteReplicationConfigurationRequest)

      Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.

      This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration action.


      This is a convenience which creates an instance of the DeleteReplicationConfigurationRequest.Builder avoiding the need to create one manually via DeleteReplicationConfigurationRequest.builder()

      Parameters:
      deleteReplicationConfigurationRequest - A Consumer that will call methods on DeleteReplicationConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteReplicationConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • ReplicationNotFoundException Returned if the specified file system does not have a replication configuration.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTags

      @Deprecated default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)
      Deprecated.
      Use UntagResource.

      DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS resources, use the API action.

      Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag restrictions in the Billing and Cost Management User Guide.

      This operation requires permissions for the elasticfilesystem:DeleteTags action.

      Parameters:
      deleteTagsRequest -
      Returns:
      A Java Future containing the result of the DeleteTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTags

      @Deprecated default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
      Deprecated.
      Use UntagResource.

      DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS resources, use the API action.

      Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag restrictions in the Billing and Cost Management User Guide.

      This operation requires permissions for the elasticfilesystem:DeleteTags action.


      This is a convenience which creates an instance of the DeleteTagsRequest.Builder avoiding the need to create one manually via DeleteTagsRequest.builder()

      Parameters:
      deleteTagsRequest - A Consumer that will call methods on DeleteTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccessPoints

      default CompletableFuture<DescribeAccessPointsResponse> describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest)

      Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both.

      This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

      Parameters:
      describeAccessPointsRequest -
      Returns:
      A Java Future containing the result of the DescribeAccessPoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccessPoints

      default CompletableFuture<DescribeAccessPointsResponse> describeAccessPoints(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)

      Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both.

      This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.


      This is a convenience which creates an instance of the DescribeAccessPointsRequest.Builder avoiding the need to create one manually via DescribeAccessPointsRequest.builder()

      Parameters:
      describeAccessPointsRequest - A Consumer that will call methods on DescribeAccessPointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccessPoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccessPointsPaginator

      default DescribeAccessPointsPublisher describeAccessPointsPaginator(DescribeAccessPointsRequest describeAccessPointsRequest)

      This is a variant of describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsPublisher publisher = client.describeAccessPointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsPublisher publisher = client.describeAccessPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation.

      Parameters:
      describeAccessPointsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccessPointsPaginator

      default DescribeAccessPointsPublisher describeAccessPointsPaginator(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)

      This is a variant of describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsPublisher publisher = client.describeAccessPointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsPublisher publisher = client.describeAccessPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest) operation.


      This is a convenience which creates an instance of the DescribeAccessPointsRequest.Builder avoiding the need to create one manually via DescribeAccessPointsRequest.builder()

      Parameters:
      describeAccessPointsRequest - A Consumer that will call methods on DescribeAccessPointsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccountPreferences

      default CompletableFuture<DescribeAccountPreferencesResponse> describeAccountPreferences(DescribeAccountPreferencesRequest describeAccountPreferencesRequest)

      Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.

      Parameters:
      describeAccountPreferencesRequest -
      Returns:
      A Java Future containing the result of the DescribeAccountPreferences operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccountPreferences

      default CompletableFuture<DescribeAccountPreferencesResponse> describeAccountPreferences(Consumer<DescribeAccountPreferencesRequest.Builder> describeAccountPreferencesRequest)

      Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.


      This is a convenience which creates an instance of the DescribeAccountPreferencesRequest.Builder avoiding the need to create one manually via DescribeAccountPreferencesRequest.builder()

      Parameters:
      describeAccountPreferencesRequest - A Consumer that will call methods on DescribeAccountPreferencesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccountPreferences operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupPolicy

      default CompletableFuture<DescribeBackupPolicyResponse> describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest)

      Returns the backup policy for the specified EFS file system.

      Parameters:
      describeBackupPolicyRequest -
      Returns:
      A Java Future containing the result of the DescribeBackupPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • PolicyNotFoundException Returned if no backup is specified for a One Zone EFS file system.
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupPolicy

      default CompletableFuture<DescribeBackupPolicyResponse> describeBackupPolicy(Consumer<DescribeBackupPolicyRequest.Builder> describeBackupPolicyRequest)

      Returns the backup policy for the specified EFS file system.


      This is a convenience which creates an instance of the DescribeBackupPolicyRequest.Builder avoiding the need to create one manually via DescribeBackupPolicyRequest.builder()

      Parameters:
      describeBackupPolicyRequest - A Consumer that will call methods on DescribeBackupPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeBackupPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • PolicyNotFoundException Returned if no backup is specified for a One Zone EFS file system.
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemPolicy

      default CompletableFuture<DescribeFileSystemPolicyResponse> describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest)

      Returns the FileSystemPolicy for the specified EFS file system.

      This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.

      Parameters:
      describeFileSystemPolicyRequest -
      Returns:
      A Java Future containing the result of the DescribeFileSystemPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • PolicyNotFoundException Returned if no backup is specified for a One Zone EFS file system.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemPolicy

      default CompletableFuture<DescribeFileSystemPolicyResponse> describeFileSystemPolicy(Consumer<DescribeFileSystemPolicyRequest.Builder> describeFileSystemPolicyRequest)

      Returns the FileSystemPolicy for the specified EFS file system.

      This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.


      This is a convenience which creates an instance of the DescribeFileSystemPolicyRequest.Builder avoiding the need to create one manually via DescribeFileSystemPolicyRequest.builder()

      Parameters:
      describeFileSystemPolicyRequest - A Consumer that will call methods on DescribeFileSystemPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFileSystemPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • PolicyNotFoundException Returned if no backup is specified for a One Zone EFS file system.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystems

      default CompletableFuture<DescribeFileSystemsResponse> describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)

      Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's 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 MaxItems parameter to limit the number of descriptions in a response. This number is automatically set to 100. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

      To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

      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 multi-call iteration is unspecified.

      This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

      Parameters:
      describeFileSystemsRequest -
      Returns:
      A Java Future containing the result of the DescribeFileSystems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystems

      default CompletableFuture<DescribeFileSystemsResponse> describeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)

      Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's 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 MaxItems parameter to limit the number of descriptions in a response. This number is automatically set to 100. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

      To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

      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 multi-call iteration is unspecified.

      This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.


      This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder avoiding the need to create one manually via DescribeFileSystemsRequest.builder()

      Parameters:
      describeFileSystemsRequest - A Consumer that will call methods on DescribeFileSystemsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFileSystems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystems

      default CompletableFuture<DescribeFileSystemsResponse> describeFileSystems()

      Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's 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 MaxItems parameter to limit the number of descriptions in a response. This number is automatically set to 100. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

      To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

      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 multi-call iteration is unspecified.

      This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

      Returns:
      A Java Future containing the result of the DescribeFileSystems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemsPaginator

      default DescribeFileSystemsPublisher describeFileSystemsPaginator()

      This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemsPaginator

      default DescribeFileSystemsPublisher describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)

      This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.

      Parameters:
      describeFileSystemsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemsPaginator

      default DescribeFileSystemsPublisher describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)

      This is a variant of describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest) operation.


      This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder avoiding the need to create one manually via DescribeFileSystemsRequest.builder()

      Parameters:
      describeFileSystemsRequest - A Consumer that will call methods on DescribeFileSystemsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLifecycleConfiguration

      default CompletableFuture<DescribeLifecycleConfigurationResponse> describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest)

      Returns the current LifecycleConfiguration object for the specified EFS file system. Lifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

      This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

      Parameters:
      describeLifecycleConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLifecycleConfiguration

      default CompletableFuture<DescribeLifecycleConfigurationResponse> describeLifecycleConfiguration(Consumer<DescribeLifecycleConfigurationRequest.Builder> describeLifecycleConfigurationRequest)

      Returns the current LifecycleConfiguration object for the specified EFS file system. Lifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

      This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.


      This is a convenience which creates an instance of the DescribeLifecycleConfigurationRequest.Builder avoiding the need to create one manually via DescribeLifecycleConfigurationRequest.builder()

      Parameters:
      describeLifecycleConfigurationRequest - A Consumer that will call methods on DescribeLifecycleConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMountTargetSecurityGroups

      default CompletableFuture<DescribeMountTargetSecurityGroupsResponse> describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)

      Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

      This operation requires permissions for the following actions:

      • elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

      • ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.

      Parameters:
      describeMountTargetSecurityGroupsRequest -
      Returns:
      A Java Future containing the result of the DescribeMountTargetSecurityGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • IncorrectMountTargetStateException Returned if the mount target is not in the correct state for the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMountTargetSecurityGroups

      default CompletableFuture<DescribeMountTargetSecurityGroupsResponse> describeMountTargetSecurityGroups(Consumer<DescribeMountTargetSecurityGroupsRequest.Builder> describeMountTargetSecurityGroupsRequest)

      Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

      This operation requires permissions for the following actions:

      • elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

      • ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.


      This is a convenience which creates an instance of the DescribeMountTargetSecurityGroupsRequest.Builder avoiding the need to create one manually via DescribeMountTargetSecurityGroupsRequest.builder()

      Parameters:
      describeMountTargetSecurityGroupsRequest - A Consumer that will call methods on DescribeMountTargetSecurityGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMountTargetSecurityGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • IncorrectMountTargetStateException Returned if the mount target is not in the correct state for the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMountTargets

      default CompletableFuture<DescribeMountTargetsResponse> describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest)

      Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.

      This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.

      Parameters:
      describeMountTargetsRequest -
      Returns:
      A Java Future containing the result of the DescribeMountTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMountTargets

      default CompletableFuture<DescribeMountTargetsResponse> describeMountTargets(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)

      Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.

      This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.


      This is a convenience which creates an instance of the DescribeMountTargetsRequest.Builder avoiding the need to create one manually via DescribeMountTargetsRequest.builder()

      Parameters:
      describeMountTargetsRequest - A Consumer that will call methods on DescribeMountTargetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMountTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMountTargetsPaginator

      default DescribeMountTargetsPublisher describeMountTargetsPaginator(DescribeMountTargetsRequest describeMountTargetsRequest)

      This is a variant of describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsPublisher publisher = client.describeMountTargetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsPublisher publisher = client.describeMountTargetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeMountTargetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeMountTargetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation.

      Parameters:
      describeMountTargetsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMountTargetsPaginator

      default DescribeMountTargetsPublisher describeMountTargetsPaginator(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)

      This is a variant of describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsPublisher publisher = client.describeMountTargetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsPublisher publisher = client.describeMountTargetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeMountTargetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeMountTargetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest) operation.


      This is a convenience which creates an instance of the DescribeMountTargetsRequest.Builder avoiding the need to create one manually via DescribeMountTargetsRequest.builder()

      Parameters:
      describeMountTargetsRequest - A Consumer that will call methods on DescribeMountTargetsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReplicationConfigurations

      default CompletableFuture<DescribeReplicationConfigurationsResponse> describeReplicationConfigurations(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)

      Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.

      Parameters:
      describeReplicationConfigurationsRequest -
      Returns:
      A Java Future containing the result of the DescribeReplicationConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ReplicationNotFoundException Returned if the specified file system does not have a replication configuration.
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReplicationConfigurations

      default CompletableFuture<DescribeReplicationConfigurationsResponse> describeReplicationConfigurations(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest)

      Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.


      This is a convenience which creates an instance of the DescribeReplicationConfigurationsRequest.Builder avoiding the need to create one manually via DescribeReplicationConfigurationsRequest.builder()

      Parameters:
      describeReplicationConfigurationsRequest - A Consumer that will call methods on DescribeReplicationConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeReplicationConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ReplicationNotFoundException Returned if the specified file system does not have a replication configuration.
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReplicationConfigurationsPaginator

      default DescribeReplicationConfigurationsPublisher describeReplicationConfigurationsPaginator(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)

      This is a variant of describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsPublisher publisher = client.describeReplicationConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsPublisher publisher = client.describeReplicationConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation.

      Parameters:
      describeReplicationConfigurationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ReplicationNotFoundException Returned if the specified file system does not have a replication configuration.
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReplicationConfigurationsPaginator

      default DescribeReplicationConfigurationsPublisher describeReplicationConfigurationsPaginator(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest)

      This is a variant of describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsPublisher publisher = client.describeReplicationConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsPublisher publisher = client.describeReplicationConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest) operation.


      This is a convenience which creates an instance of the DescribeReplicationConfigurationsRequest.Builder avoiding the need to create one manually via DescribeReplicationConfigurationsRequest.builder()

      Parameters:
      describeReplicationConfigurationsRequest - A Consumer that will call methods on DescribeReplicationConfigurationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ReplicationNotFoundException Returned if the specified file system does not have a replication configuration.
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTags

      @Deprecated default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)
      Deprecated.
      Use ListTagsForResource.

      DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource API action.

      Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.

      This operation requires permissions for the elasticfilesystem:DescribeTags action.

      Parameters:
      describeTagsRequest -
      Returns:
      A Java Future containing the result of the DescribeTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTags

      @Deprecated default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
      Deprecated.
      Use ListTagsForResource.

      DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource API action.

      Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.

      This operation requires permissions for the elasticfilesystem:DescribeTags action.


      This is a convenience which creates an instance of the DescribeTagsRequest.Builder avoiding the need to create one manually via DescribeTagsRequest.builder()

      Parameters:
      describeTagsRequest - A Consumer that will call methods on DescribeTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTagsPaginator

      @Deprecated default DescribeTagsPublisher describeTagsPaginator(DescribeTagsRequest describeTagsRequest)
      Deprecated.
      Use ListTagsForResource.

      This is a variant of describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeTagsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest) operation.

      Parameters:
      describeTagsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTagsPaginator

      @Deprecated default DescribeTagsPublisher describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
      Deprecated.
      Use ListTagsForResource.

      This is a variant of describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.DescribeTagsPublisher publisher = client.describeTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.DescribeTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.DescribeTagsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest) operation.


      This is a convenience which creates an instance of the DescribeTagsRequest.Builder avoiding the need to create one manually via DescribeTagsRequest.builder()

      Parameters:
      describeTagsRequest - A Consumer that will call methods on DescribeTagsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.

      This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.

      This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.efs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.efs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest) operation.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyMountTargetSecurityGroups

      default CompletableFuture<ModifyMountTargetSecurityGroupsResponse> modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)

      Modifies the set of security groups in effect for a mount target.

      When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

      The operation requires permissions for the following actions:

      • elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

      • ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.

      Parameters:
      modifyMountTargetSecurityGroupsRequest -
      Returns:
      A Java Future containing the result of the ModifyMountTargetSecurityGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • IncorrectMountTargetStateException Returned if the mount target is not in the correct state for the operation.
      • SecurityGroupLimitExceededException Returned if the number of SecurityGroups specified in the request is greater than the limit, which is based on account quota. Either delete some security groups or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table).
      • SecurityGroupNotFoundException Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyMountTargetSecurityGroups

      default CompletableFuture<ModifyMountTargetSecurityGroupsResponse> modifyMountTargetSecurityGroups(Consumer<ModifyMountTargetSecurityGroupsRequest.Builder> modifyMountTargetSecurityGroupsRequest)

      Modifies the set of security groups in effect for a mount target.

      When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

      The operation requires permissions for the following actions:

      • elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

      • ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.


      This is a convenience which creates an instance of the ModifyMountTargetSecurityGroupsRequest.Builder avoiding the need to create one manually via ModifyMountTargetSecurityGroupsRequest.builder()

      Parameters:
      modifyMountTargetSecurityGroupsRequest - A Consumer that will call methods on ModifyMountTargetSecurityGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyMountTargetSecurityGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • MountTargetNotFoundException Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
      • IncorrectMountTargetStateException Returned if the mount target is not in the correct state for the operation.
      • SecurityGroupLimitExceededException Returned if the number of SecurityGroups specified in the request is greater than the limit, which is based on account quota. Either delete some security groups or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table).
      • SecurityGroupNotFoundException Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccountPreferences

      default CompletableFuture<PutAccountPreferencesResponse> putAccountPreferences(PutAccountPreferencesRequest putAccountPreferencesRequest)

      Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs.

      Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.

      Parameters:
      putAccountPreferencesRequest -
      Returns:
      A Java Future containing the result of the PutAccountPreferences operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAccountPreferences

      default CompletableFuture<PutAccountPreferencesResponse> putAccountPreferences(Consumer<PutAccountPreferencesRequest.Builder> putAccountPreferencesRequest)

      Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs.

      Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.


      This is a convenience which creates an instance of the PutAccountPreferencesRequest.Builder avoiding the need to create one manually via PutAccountPreferencesRequest.builder()

      Parameters:
      putAccountPreferencesRequest - A Consumer that will call methods on PutAccountPreferencesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAccountPreferences operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBackupPolicy

      default CompletableFuture<PutBackupPolicyResponse> putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest)

      Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

      Parameters:
      putBackupPolicyRequest -
      Returns:
      A Java Future containing the result of the PutBackupPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putBackupPolicy

      default CompletableFuture<PutBackupPolicyResponse> putBackupPolicy(Consumer<PutBackupPolicyRequest.Builder> putBackupPolicyRequest)

      Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.


      This is a convenience which creates an instance of the PutBackupPolicyRequest.Builder avoiding the need to create one manually via PutBackupPolicyRequest.builder()

      Parameters:
      putBackupPolicyRequest - A Consumer that will call methods on PutBackupPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutBackupPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ValidationException Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putFileSystemPolicy

      default CompletableFuture<PutFileSystemPolicyResponse> putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)

      Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS file system policy.

      EFS file system policies have a 20,000 character limit.

      This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.

      Parameters:
      putFileSystemPolicyRequest -
      Returns:
      A Java Future containing the result of the PutFileSystemPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • InvalidPolicyException Returned if the FileSystemPolicy is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putFileSystemPolicy

      default CompletableFuture<PutFileSystemPolicyResponse> putFileSystemPolicy(Consumer<PutFileSystemPolicyRequest.Builder> putFileSystemPolicyRequest)

      Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS file system policy.

      EFS file system policies have a 20,000 character limit.

      This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.


      This is a convenience which creates an instance of the PutFileSystemPolicyRequest.Builder avoiding the need to create one manually via PutFileSystemPolicyRequest.builder()

      Parameters:
      putFileSystemPolicyRequest - A Consumer that will call methods on PutFileSystemPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutFileSystemPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • InvalidPolicyException Returned if the FileSystemPolicy is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putLifecycleConfiguration

      default CompletableFuture<PutLifecycleConfigurationResponse> putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest)

      Use this action to manage storage for your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:

      • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

      • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

        File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

        The Archive storage class is available only for file systems that use the Elastic throughput mode and the General Purpose performance mode.

      • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

      For more information, see Managing file system storage.

      Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration. In the request, specify the following:

      • The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.

      • A LifecyclePolicies array of LifecyclePolicy objects that define when to move files to IA storage, to Archive storage, and back to primary storage.

        Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information.

      This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

      To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.

      Parameters:
      putLifecycleConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putLifecycleConfiguration

      default CompletableFuture<PutLifecycleConfigurationResponse> putLifecycleConfiguration(Consumer<PutLifecycleConfigurationRequest.Builder> putLifecycleConfigurationRequest)

      Use this action to manage storage for your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:

      • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

      • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

        File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

        The Archive storage class is available only for file systems that use the Elastic throughput mode and the General Purpose performance mode.

      • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

      For more information, see Managing file system storage.

      Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration. In the request, specify the following:

      • The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.

      • A LifecyclePolicies array of LifecyclePolicy objects that define when to move files to IA storage, to Archive storage, and back to primary storage.

        Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information.

      This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

      To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.


      This is a convenience which creates an instance of the PutLifecycleConfigurationRequest.Builder avoiding the need to create one manually via PutLifecycleConfigurationRequest.builder()

      Parameters:
      putLifecycleConfigurationRequest - A Consumer that will call methods on PutLifecycleConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutLifecycleConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.

      This operation requires permissions for the elasticfilesystem:TagResource action.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.

      This operation requires permissions for the elasticfilesystem:TagResource action.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.

      This operation requires permissions for the elasticfilesystem:UntagResource action.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.

      This operation requires permissions for the elasticfilesystem:UntagResource action.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • AccessPointNotFoundException Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileSystem

      default CompletableFuture<UpdateFileSystemResponse> updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)

      Updates the throughput mode or the amount of provisioned throughput of an existing file system.

      Parameters:
      updateFileSystemRequest -
      Returns:
      A Java Future containing the result of the UpdateFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • InsufficientThroughputCapacityException Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ThroughputLimitExceededException Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
      • TooManyRequestsException Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileSystem

      default CompletableFuture<UpdateFileSystemResponse> updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)

      Updates the throughput mode or the amount of provisioned throughput of an existing file system.


      This is a convenience which creates an instance of the UpdateFileSystemRequest.Builder avoiding the need to create one manually via UpdateFileSystemRequest.builder()

      Parameters:
      updateFileSystemRequest - A Consumer that will call methods on UpdateFileSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • InsufficientThroughputCapacityException Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ThroughputLimitExceededException Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
      • TooManyRequestsException Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileSystemProtection

      default CompletableFuture<UpdateFileSystemProtectionResponse> updateFileSystemProtection(UpdateFileSystemProtectionRequest updateFileSystemProtectionRequest)

      Updates protection on the file system.

      This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection action.

      Parameters:
      updateFileSystemProtectionRequest -
      Returns:
      A Java Future containing the result of the UpdateFileSystemProtection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • InsufficientThroughputCapacityException Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ThroughputLimitExceededException Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
      • ReplicationAlreadyExistsException Returned if the file system is already included in a replication configuration.>
      • TooManyRequestsException Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileSystemProtection

      default CompletableFuture<UpdateFileSystemProtectionResponse> updateFileSystemProtection(Consumer<UpdateFileSystemProtectionRequest.Builder> updateFileSystemProtectionRequest)

      Updates protection on the file system.

      This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection action.


      This is a convenience which creates an instance of the UpdateFileSystemProtectionRequest.Builder avoiding the need to create one manually via UpdateFileSystemProtectionRequest.builder()

      Parameters:
      updateFileSystemProtectionRequest - A Consumer that will call methods on UpdateFileSystemProtectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFileSystemProtection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
      • FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
      • IncorrectFileSystemLifeCycleStateException Returned if the file system's lifecycle state is not "available".
      • InsufficientThroughputCapacityException Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
      • InternalServerErrorException Returned if an error occurred on the server side.
      • ThroughputLimitExceededException Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
      • ReplicationAlreadyExistsException Returned if the file system is already included in a replication configuration.>
      • TooManyRequestsException Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EfsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default EfsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static EfsAsyncClient create()
      Create a EfsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static EfsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a EfsAsyncClient.