Interface EfsClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EfsClient extends AwsClient
Service client for accessing EFS. This can be created using the staticbuilder()method.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 Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description static EfsClientBuilderbuilder()Create a builder that can be used to configure and create aEfsClient.static EfsClientcreate()Create aEfsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAccessPointResponsecreateAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)Creates an EFS access point.default CreateAccessPointResponsecreateAccessPoint(CreateAccessPointRequest createAccessPointRequest)Creates an EFS access point.default CreateFileSystemResponsecreateFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)Creates a new, empty file system.default CreateFileSystemResponsecreateFileSystem(CreateFileSystemRequest createFileSystemRequest)Creates a new, empty file system.default CreateMountTargetResponsecreateMountTarget(Consumer<CreateMountTargetRequest.Builder> createMountTargetRequest)Creates a mount target for a file system.default CreateMountTargetResponsecreateMountTarget(CreateMountTargetRequest createMountTargetRequest)Creates a mount target for a file system.default CreateReplicationConfigurationResponsecreateReplicationConfiguration(Consumer<CreateReplicationConfigurationRequest.Builder> createReplicationConfigurationRequest)Creates a replication configuration to either a new or existing EFS file system.default CreateReplicationConfigurationResponsecreateReplicationConfiguration(CreateReplicationConfigurationRequest createReplicationConfigurationRequest)Creates a replication configuration to either a new or existing EFS file system.default CreateTagsResponsecreateTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)Deprecated.Use TagResource.default CreateTagsResponsecreateTags(CreateTagsRequest createTagsRequest)Deprecated.Use TagResource.default DeleteAccessPointResponsedeleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)Deletes the specified access point.default DeleteAccessPointResponsedeleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)Deletes the specified access point.default DeleteFileSystemResponsedeleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)Deletes a file system, permanently severing access to its contents.default DeleteFileSystemResponsedeleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)Deletes a file system, permanently severing access to its contents.default DeleteFileSystemPolicyResponsedeleteFileSystemPolicy(Consumer<DeleteFileSystemPolicyRequest.Builder> deleteFileSystemPolicyRequest)Deletes theFileSystemPolicyfor the specified file system.default DeleteFileSystemPolicyResponsedeleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)Deletes theFileSystemPolicyfor the specified file system.default DeleteMountTargetResponsedeleteMountTarget(Consumer<DeleteMountTargetRequest.Builder> deleteMountTargetRequest)Deletes the specified mount target.default DeleteMountTargetResponsedeleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)Deletes the specified mount target.default DeleteReplicationConfigurationResponsedeleteReplicationConfiguration(Consumer<DeleteReplicationConfigurationRequest.Builder> deleteReplicationConfigurationRequest)Deletes a replication configuration.default DeleteReplicationConfigurationResponsedeleteReplicationConfiguration(DeleteReplicationConfigurationRequest deleteReplicationConfigurationRequest)Deletes a replication configuration.default DeleteTagsResponsedeleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)Deprecated.Use UntagResource.default DeleteTagsResponsedeleteTags(DeleteTagsRequest deleteTagsRequest)Deprecated.Use UntagResource.default DescribeAccessPointsResponsedescribeAccessPoints(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)Returns the description of a specific Amazon EFS access point if theAccessPointIdis provided.default DescribeAccessPointsResponsedescribeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest)Returns the description of a specific Amazon EFS access point if theAccessPointIdis provided.default DescribeAccessPointsIterabledescribeAccessPointsPaginator(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest)This is a variant ofdescribeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest)operation.default DescribeAccessPointsIterabledescribeAccessPointsPaginator(DescribeAccessPointsRequest describeAccessPointsRequest)This is a variant ofdescribeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest)operation.default DescribeAccountPreferencesResponsedescribeAccountPreferences(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.default DescribeAccountPreferencesResponsedescribeAccountPreferences(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.default DescribeBackupPolicyResponsedescribeBackupPolicy(Consumer<DescribeBackupPolicyRequest.Builder> describeBackupPolicyRequest)Returns the backup policy for the specified EFS file system.default DescribeBackupPolicyResponsedescribeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest)Returns the backup policy for the specified EFS file system.default DescribeFileSystemPolicyResponsedescribeFileSystemPolicy(Consumer<DescribeFileSystemPolicyRequest.Builder> describeFileSystemPolicyRequest)Returns theFileSystemPolicyfor the specified EFS file system.default DescribeFileSystemPolicyResponsedescribeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest)Returns theFileSystemPolicyfor the specified EFS file system.default DescribeFileSystemsResponsedescribeFileSystems()Returns the description of a specific Amazon EFS file system if either the file systemCreationTokenor theFileSystemIdis provided.default DescribeFileSystemsResponsedescribeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)Returns the description of a specific Amazon EFS file system if either the file systemCreationTokenor theFileSystemIdis provided.default DescribeFileSystemsResponsedescribeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)Returns the description of a specific Amazon EFS file system if either the file systemCreationTokenor theFileSystemIdis provided.default DescribeFileSystemsIterabledescribeFileSystemsPaginator()This is a variant ofdescribeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)operation.default DescribeFileSystemsIterabledescribeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)This is a variant ofdescribeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)operation.default DescribeFileSystemsIterabledescribeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)This is a variant ofdescribeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)operation.default DescribeLifecycleConfigurationResponsedescribeLifecycleConfiguration(Consumer<DescribeLifecycleConfigurationRequest.Builder> describeLifecycleConfigurationRequest)Returns the currentLifecycleConfigurationobject for the specified Amazon EFS file system.default DescribeLifecycleConfigurationResponsedescribeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest)Returns the currentLifecycleConfigurationobject for the specified Amazon EFS file system.default DescribeMountTargetsResponsedescribeMountTargets(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.default DescribeMountTargetsResponsedescribeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest)Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.default DescribeMountTargetSecurityGroupsResponsedescribeMountTargetSecurityGroups(Consumer<DescribeMountTargetSecurityGroupsRequest.Builder> describeMountTargetSecurityGroupsRequest)Returns the security groups currently in effect for a mount target.default DescribeMountTargetSecurityGroupsResponsedescribeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)Returns the security groups currently in effect for a mount target.default DescribeMountTargetsIterabledescribeMountTargetsPaginator(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest)This is a variant ofdescribeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest)operation.default DescribeMountTargetsIterabledescribeMountTargetsPaginator(DescribeMountTargetsRequest describeMountTargetsRequest)This is a variant ofdescribeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest)operation.default DescribeReplicationConfigurationsResponsedescribeReplicationConfigurations(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest)Retrieves the replication configuration for a specific file system.default DescribeReplicationConfigurationsResponsedescribeReplicationConfigurations(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)Retrieves the replication configuration for a specific file system.default DescribeReplicationConfigurationsIterabledescribeReplicationConfigurationsPaginator(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest)This is a variant ofdescribeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest)operation.default DescribeReplicationConfigurationsIterabledescribeReplicationConfigurationsPaginator(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)This is a variant ofdescribeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest)operation.default DescribeTagsResponsedescribeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)Deprecated.Use ListTagsForResource.default DescribeTagsResponsedescribeTags(DescribeTagsRequest describeTagsRequest)Deprecated.Use ListTagsForResource.default DescribeTagsIterabledescribeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)Deprecated.Use ListTagsForResource.default DescribeTagsIterabledescribeTagsPaginator(DescribeTagsRequest describeTagsRequest)Deprecated.Use ListTagsForResource.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists all tags for a top-level EFS resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists all tags for a top-level EFS resource.default ListTagsForResourceIterablelistTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)This is a variant oflistTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest)operation.default ListTagsForResourceIterablelistTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)This is a variant oflistTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest)operation.default ModifyMountTargetSecurityGroupsResponsemodifyMountTargetSecurityGroups(Consumer<ModifyMountTargetSecurityGroupsRequest.Builder> modifyMountTargetSecurityGroupsRequest)Modifies the set of security groups in effect for a mount target.default ModifyMountTargetSecurityGroupsResponsemodifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)Modifies the set of security groups in effect for a mount target.default PutAccountPreferencesResponseputAccountPreferences(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.default PutAccountPreferencesResponseputAccountPreferences(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.default PutBackupPolicyResponseputBackupPolicy(Consumer<PutBackupPolicyRequest.Builder> putBackupPolicyRequest)Updates the file system's backup policy.default PutBackupPolicyResponseputBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest)Updates the file system's backup policy.default PutFileSystemPolicyResponseputFileSystemPolicy(Consumer<PutFileSystemPolicyRequest.Builder> putFileSystemPolicyRequest)Applies an Amazon EFSFileSystemPolicyto an Amazon EFS file system.default PutFileSystemPolicyResponseputFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)Applies an Amazon EFSFileSystemPolicyto an Amazon EFS file system.default PutLifecycleConfigurationResponseputLifecycleConfiguration(Consumer<PutLifecycleConfigurationRequest.Builder> putLifecycleConfigurationRequest)Use this action to manage storage for your file system.default PutLifecycleConfigurationResponseputLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest)Use this action to manage storage for your file system.default EfsServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Creates a tag for an EFS resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Creates a tag for an EFS resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes tags from an EFS resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes tags from an EFS resource.default UpdateFileSystemResponseupdateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)Updates the throughput mode or the amount of provisioned throughput of an existing file system.default UpdateFileSystemResponseupdateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)Updates the throughput mode or the amount of provisioned throughput of an existing file system.default UpdateFileSystemProtectionResponseupdateFileSystemProtection(Consumer<UpdateFileSystemProtectionRequest.Builder> updateFileSystemProtectionRequest)Updates protection on the file system.default UpdateFileSystemProtectionResponseupdateFileSystemProtection(UpdateFileSystemProtectionRequest updateFileSystemProtectionRequest)Updates protection on the file system.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createAccessPoint
default CreateAccessPointResponse createAccessPoint(CreateAccessPointRequest createAccessPointRequest) throws BadRequestException, AccessPointAlreadyExistsException, IncorrectFileSystemLifeCycleStateException, InternalServerErrorException, FileSystemNotFoundException, AccessPointLimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, EfsException
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. 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 1,000 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:CreateAccessPointaction.Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the
elasticfilesystem:TagResourceaction to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use theelasticfilesystem:TagResourceaction. For more information, see Granting permissions to tag resources during creation.- Parameters:
createAccessPointRequest-- Returns:
- Result of the CreateAccessPoint operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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 theCreateAccessPointAPI 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.AwsServiceException- See Also:
- AWS API Documentation
-
createAccessPoint
default CreateAccessPointResponse createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest) throws BadRequestException, AccessPointAlreadyExistsException, IncorrectFileSystemLifeCycleStateException, InternalServerErrorException, FileSystemNotFoundException, AccessPointLimitExceededException, ThrottlingException, AwsServiceException, SdkClientException, EfsException
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. 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 1,000 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:CreateAccessPointaction.Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the
elasticfilesystem:TagResourceaction to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use theelasticfilesystem:TagResourceaction. For more information, see Granting permissions to tag resources during creation.
This is a convenience which creates an instance of the
CreateAccessPointRequest.Builderavoiding the need to create one manually viaCreateAccessPointRequest.builder()- Parameters:
createAccessPointRequest- AConsumerthat will call methods onCreateAccessPointRequest.Builderto create a request.- Returns:
- Result of the CreateAccessPoint operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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 theCreateAccessPointAPI 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.AwsServiceException- See Also:
- AWS API Documentation
-
createFileSystem
default CreateFileSystemResponse createFileSystem(CreateFileSystemRequest createFileSystemRequest) throws BadRequestException, InternalServerErrorException, FileSystemAlreadyExistsException, FileSystemLimitExceededException, InsufficientThroughputCapacityException, ThroughputLimitExceededException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EfsException
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
FileSystemAlreadyExistserror 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
CreateFileSystemcall 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 theFileSystemAlreadyExistserror.For more information, see Creating a file system in the Amazon EFS User Guide.
The
CreateFileSystemcall returns while the file system's lifecycle state is stillcreating. 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
PerformanceModeparameter that you choose for your file system. We recommendgeneralPurposePerformanceModefor all file systems. ThemaxIOmode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than thegeneralPurposemode.MaxIOmode is not supported for One Zone file systems or file systems that use Elastic throughput.The
PerformanceModecan'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
ThroughputModeparameter.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:CreateFileSystemaction.File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the
elasticfilesystem:TagResourceaction to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use theelasticfilesystem:TagResourceaction. For more information, see Granting permissions to tag resources during creation.- Parameters:
createFileSystemRequest-- Returns:
- Result of the CreateFileSystem operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createFileSystem
default CreateFileSystemResponse createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest) throws BadRequestException, InternalServerErrorException, FileSystemAlreadyExistsException, FileSystemLimitExceededException, InsufficientThroughputCapacityException, ThroughputLimitExceededException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EfsException
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
FileSystemAlreadyExistserror 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
CreateFileSystemcall 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 theFileSystemAlreadyExistserror.For more information, see Creating a file system in the Amazon EFS User Guide.
The
CreateFileSystemcall returns while the file system's lifecycle state is stillcreating. 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
PerformanceModeparameter that you choose for your file system. We recommendgeneralPurposePerformanceModefor all file systems. ThemaxIOmode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than thegeneralPurposemode.MaxIOmode is not supported for One Zone file systems or file systems that use Elastic throughput.The
PerformanceModecan'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
ThroughputModeparameter.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:CreateFileSystemaction.File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the
elasticfilesystem:TagResourceaction to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use theelasticfilesystem:TagResourceaction. For more information, see Granting permissions to tag resources during creation.
This is a convenience which creates an instance of the
CreateFileSystemRequest.Builderavoiding the need to create one manually viaCreateFileSystemRequest.builder()- Parameters:
createFileSystemRequest- AConsumerthat will call methods onCreateFileSystemRequest.Builderto create a request.- Returns:
- Result of the CreateFileSystem operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createMountTarget
default CreateMountTargetResponse createMountTarget(CreateMountTargetRequest createMountTargetRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, MountTargetConflictException, SubnetNotFoundException, NoFreeAddressesInSubnetException, IpAddressInUseException, NetworkInterfaceLimitExceededException, SecurityGroupLimitExceededException, SecurityGroupNotFoundException, UnsupportedAvailabilityZoneException, AvailabilityZonesMismatchException, AwsServiceException, SdkClientException, EfsException
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
AvailabilityZoneNameandAvailabiltyZoneIdproperties in the DescribeFileSystems response object to get this information. Use thesubnetIdassociated 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
MountTargetIdand anIpAddress. 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 EC2CreateNetworkInterfacecall 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-idwherefsmt-idis the mount target ID, andfs-idis theFileSystemId. -
Sets the
requesterManagedproperty of the network interface totrue, and therequesterIdvalue toEFS.
Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the
NetworkInterfaceIdfield in the mount target's description to the network interface ID, and theIpAddressfield to its address. If network interface creation fails, the entireCreateMountTargetoperation fails. -
The
CreateMountTargetcall returns only after creating the network interface, but while the mount target state is stillcreating, 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. 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:
- Result of the CreateMountTarget operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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 IDSubnetIdprovided in the request.NoFreeAddressesInSubnetException- Returned ifIpAddresswas not specified in the request and there are no free IP addresses in the subnet.IpAddressInUseException- Returned if the request specified anIpAddressthat 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 size ofSecurityGroupsspecified in the request is greater than five.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createMountTarget
default CreateMountTargetResponse createMountTarget(Consumer<CreateMountTargetRequest.Builder> createMountTargetRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, MountTargetConflictException, SubnetNotFoundException, NoFreeAddressesInSubnetException, IpAddressInUseException, NetworkInterfaceLimitExceededException, SecurityGroupLimitExceededException, SecurityGroupNotFoundException, UnsupportedAvailabilityZoneException, AvailabilityZonesMismatchException, AwsServiceException, SdkClientException, EfsException
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
AvailabilityZoneNameandAvailabiltyZoneIdproperties in the DescribeFileSystems response object to get this information. Use thesubnetIdassociated 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
MountTargetIdand anIpAddress. 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 EC2CreateNetworkInterfacecall 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-idwherefsmt-idis the mount target ID, andfs-idis theFileSystemId. -
Sets the
requesterManagedproperty of the network interface totrue, and therequesterIdvalue toEFS.
Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the
NetworkInterfaceIdfield in the mount target's description to the network interface ID, and theIpAddressfield to its address. If network interface creation fails, the entireCreateMountTargetoperation fails. -
The
CreateMountTargetcall returns only after creating the network interface, but while the mount target state is stillcreating, 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. 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.Builderavoiding the need to create one manually viaCreateMountTargetRequest.builder()- Parameters:
createMountTargetRequest- AConsumerthat will call methods onCreateMountTargetRequest.Builderto create a request.- Returns:
- Result of the CreateMountTarget operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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 IDSubnetIdprovided in the request.NoFreeAddressesInSubnetException- Returned ifIpAddresswas not specified in the request and there are no free IP addresses in the subnet.IpAddressInUseException- Returned if the request specified anIpAddressthat 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 size ofSecurityGroupsspecified in the request is greater than five.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createReplicationConfiguration
default CreateReplicationConfigurationResponse createReplicationConfiguration(CreateReplicationConfigurationRequest createReplicationConfigurationRequest) throws BadRequestException, IncorrectFileSystemLifeCycleStateException, ValidationException, ReplicationNotFoundException, FileSystemNotFoundException, UnsupportedAvailabilityZoneException, FileSystemLimitExceededException, InsufficientThroughputCapacityException, ThroughputLimitExceededException, ConflictException, InternalServerErrorException, AwsServiceException, SdkClientException, EfsException
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:CreateReplicationConfigurationaction. 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:
- Result of the CreateReplicationConfiguration operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createReplicationConfiguration
default CreateReplicationConfigurationResponse createReplicationConfiguration(Consumer<CreateReplicationConfigurationRequest.Builder> createReplicationConfigurationRequest) throws BadRequestException, IncorrectFileSystemLifeCycleStateException, ValidationException, ReplicationNotFoundException, FileSystemNotFoundException, UnsupportedAvailabilityZoneException, FileSystemLimitExceededException, InsufficientThroughputCapacityException, ThroughputLimitExceededException, ConflictException, InternalServerErrorException, AwsServiceException, SdkClientException, EfsException
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:CreateReplicationConfigurationaction. 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.Builderavoiding the need to create one manually viaCreateReplicationConfigurationRequest.builder()- Parameters:
createReplicationConfigurationRequest- AConsumerthat will call methods onCreateReplicationConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateReplicationConfiguration operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createTags
@Deprecated default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Deprecated.Use TagResource.DEPRECATED -
CreateTagsis 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
Nametag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.This operation requires permission for the
elasticfilesystem:CreateTagsaction.- Parameters:
createTagsRequest-- Returns:
- Result of the CreateTags operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTags
@Deprecated default CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Deprecated.Use TagResource.DEPRECATED -
CreateTagsis 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
Nametag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.This operation requires permission for the
elasticfilesystem:CreateTagsaction.
This is a convenience which creates an instance of the
CreateTagsRequest.Builderavoiding the need to create one manually viaCreateTagsRequest.builder()- Parameters:
createTagsRequest- AConsumerthat will call methods onCreateTagsRequest.Builderto create a request.- Returns:
- Result of the CreateTags operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccessPoint
default DeleteAccessPointResponse deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest) throws BadRequestException, InternalServerErrorException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:DeleteAccessPointaction.- Parameters:
deleteAccessPointRequest-- Returns:
- Result of the DeleteAccessPoint operation returned by the service.
- Throws:
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 specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccessPoint
default DeleteAccessPointResponse deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest) throws BadRequestException, InternalServerErrorException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:DeleteAccessPointaction.
This is a convenience which creates an instance of the
DeleteAccessPointRequest.Builderavoiding the need to create one manually viaDeleteAccessPointRequest.builder()- Parameters:
deleteAccessPointRequest- AConsumerthat will call methods onDeleteAccessPointRequest.Builderto create a request.- Returns:
- Result of the DeleteAccessPoint operation returned by the service.
- Throws:
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 specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFileSystem
default DeleteFileSystemResponse deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, FileSystemInUseException, AwsServiceException, SdkClientException, EfsException
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
DeleteFileSystemcall returns while the file system state is stilldeleting. 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 a404 FileSystemNotFounderror.This operation requires permissions for the
elasticfilesystem:DeleteFileSystemaction.- Parameters:
deleteFileSystemRequest-- Returns:
- Result of the DeleteFileSystem operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFileSystem
default DeleteFileSystemResponse deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, FileSystemInUseException, AwsServiceException, SdkClientException, EfsException
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
DeleteFileSystemcall returns while the file system state is stilldeleting. 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 a404 FileSystemNotFounderror.This operation requires permissions for the
elasticfilesystem:DeleteFileSystemaction.
This is a convenience which creates an instance of the
DeleteFileSystemRequest.Builderavoiding the need to create one manually viaDeleteFileSystemRequest.builder()- Parameters:
deleteFileSystemRequest- AConsumerthat will call methods onDeleteFileSystemRequest.Builderto create a request.- Returns:
- Result of the DeleteFileSystem operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFileSystemPolicy
default DeleteFileSystemPolicyResponse deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, AwsServiceException, SdkClientException, EfsException
Deletes the
FileSystemPolicyfor the specified file system. The defaultFileSystemPolicygoes 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:DeleteFileSystemPolicyaction.- Parameters:
deleteFileSystemPolicyRequest-- Returns:
- Result of the DeleteFileSystemPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFileSystemPolicy
default DeleteFileSystemPolicyResponse deleteFileSystemPolicy(Consumer<DeleteFileSystemPolicyRequest.Builder> deleteFileSystemPolicyRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, AwsServiceException, SdkClientException, EfsException
Deletes the
FileSystemPolicyfor the specified file system. The defaultFileSystemPolicygoes 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:DeleteFileSystemPolicyaction.
This is a convenience which creates an instance of the
DeleteFileSystemPolicyRequest.Builderavoiding the need to create one manually viaDeleteFileSystemPolicyRequest.builder()- Parameters:
deleteFileSystemPolicyRequest- AConsumerthat will call methods onDeleteFileSystemPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteFileSystemPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMountTarget
default DeleteMountTargetResponse deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest) throws BadRequestException, InternalServerErrorException, DependencyTimeoutException, MountTargetNotFoundException, AwsServiceException, SdkClientException, EfsException
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
DeleteMountTargetcall returns while the mount target state is stilldeleting. 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:
- Result of the DeleteMountTarget operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteMountTarget
default DeleteMountTargetResponse deleteMountTarget(Consumer<DeleteMountTargetRequest.Builder> deleteMountTargetRequest) throws BadRequestException, InternalServerErrorException, DependencyTimeoutException, MountTargetNotFoundException, AwsServiceException, SdkClientException, EfsException
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
DeleteMountTargetcall returns while the mount target state is stilldeleting. 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.Builderavoiding the need to create one manually viaDeleteMountTargetRequest.builder()- Parameters:
deleteMountTargetRequest- AConsumerthat will call methods onDeleteMountTargetRequest.Builderto create a request.- Returns:
- Result of the DeleteMountTarget operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteReplicationConfiguration
default DeleteReplicationConfigurationResponse deleteReplicationConfiguration(DeleteReplicationConfigurationRequest deleteReplicationConfigurationRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, ReplicationNotFoundException, AwsServiceException, SdkClientException, EfsException
Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes
Writeableand its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.This operation requires permissions for the
elasticfilesystem:DeleteReplicationConfigurationaction.- Parameters:
deleteReplicationConfigurationRequest-- Returns:
- Result of the DeleteReplicationConfiguration operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteReplicationConfiguration
default DeleteReplicationConfigurationResponse deleteReplicationConfiguration(Consumer<DeleteReplicationConfigurationRequest.Builder> deleteReplicationConfigurationRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, ReplicationNotFoundException, AwsServiceException, SdkClientException, EfsException
Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes
Writeableand its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.This operation requires permissions for the
elasticfilesystem:DeleteReplicationConfigurationaction.
This is a convenience which creates an instance of the
DeleteReplicationConfigurationRequest.Builderavoiding the need to create one manually viaDeleteReplicationConfigurationRequest.builder()- Parameters:
deleteReplicationConfigurationRequest- AConsumerthat will call methods onDeleteReplicationConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteReplicationConfiguration operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTags
@Deprecated default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Deprecated.Use UntagResource.DEPRECATED -
DeleteTagsis deprecated and not maintained. To remove tags from EFS resources, use the API action.Deletes the specified tags from a file system. If the
DeleteTagsrequest 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:DeleteTagsaction.- Parameters:
deleteTagsRequest-- Returns:
- Result of the DeleteTags operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTags
@Deprecated default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Deprecated.Use UntagResource.DEPRECATED -
DeleteTagsis deprecated and not maintained. To remove tags from EFS resources, use the API action.Deletes the specified tags from a file system. If the
DeleteTagsrequest 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:DeleteTagsaction.
This is a convenience which creates an instance of the
DeleteTagsRequest.Builderavoiding the need to create one manually viaDeleteTagsRequest.builder()- Parameters:
deleteTagsRequest- AConsumerthat will call methods onDeleteTagsRequest.Builderto create a request.- Returns:
- Result of the DeleteTags operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccessPoints
default DescribeAccessPointsResponse describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the description of a specific Amazon EFS access point if the
AccessPointIdis provided. If you provide an EFSFileSystemId, it returns descriptions of all access points for that file system. You can provide either anAccessPointIdor aFileSystemIdin the request, but not both.This operation requires permissions for the
elasticfilesystem:DescribeAccessPointsaction.- Parameters:
describeAccessPointsRequest-- Returns:
- Result of the DescribeAccessPoints operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccessPoints
default DescribeAccessPointsResponse describeAccessPoints(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the description of a specific Amazon EFS access point if the
AccessPointIdis provided. If you provide an EFSFileSystemId, it returns descriptions of all access points for that file system. You can provide either anAccessPointIdor aFileSystemIdin the request, but not both.This operation requires permissions for the
elasticfilesystem:DescribeAccessPointsaction.
This is a convenience which creates an instance of the
DescribeAccessPointsRequest.Builderavoiding the need to create one manually viaDescribeAccessPointsRequest.builder()- Parameters:
describeAccessPointsRequest- AConsumerthat will call methods onDescribeAccessPointsRequest.Builderto create a request.- Returns:
- Result of the DescribeAccessPoints operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccessPointsPaginator
default DescribeAccessPointsIterable describeAccessPointsPaginator(DescribeAccessPointsRequest describeAccessPointsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client.describeAccessPointsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client .describeAccessPointsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client.describeAccessPointsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccessPointsPaginator
default DescribeAccessPointsIterable describeAccessPointsPaginator(Consumer<DescribeAccessPointsRequest.Builder> describeAccessPointsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeAccessPoints(software.amazon.awssdk.services.efs.model.DescribeAccessPointsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client.describeAccessPointsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client .describeAccessPointsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeAccessPointsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeAccessPointsIterable responses = client.describeAccessPointsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeAccessPointsRequest.builder()- Parameters:
describeAccessPointsRequest- AConsumerthat will call methods onDescribeAccessPointsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountPreferences
default DescribeAccountPreferencesResponse describeAccountPreferences(DescribeAccountPreferencesRequest describeAccountPreferencesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, EfsException
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:
- Result of the DescribeAccountPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountPreferences
default DescribeAccountPreferencesResponse describeAccountPreferences(Consumer<DescribeAccountPreferencesRequest.Builder> describeAccountPreferencesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, EfsException
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.Builderavoiding the need to create one manually viaDescribeAccountPreferencesRequest.builder()- Parameters:
describeAccountPreferencesRequest- AConsumerthat will call methods onDescribeAccountPreferencesRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeBackupPolicy
default DescribeBackupPolicyResponse describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, PolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EfsException
Returns the backup policy for the specified EFS file system.
- Parameters:
describeBackupPolicyRequest-- Returns:
- Result of the DescribeBackupPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.InternalServerErrorException- Returned if an error occurred on the server side.PolicyNotFoundException- Returned if the default file system policy is in effect for the EFS file system specified.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeBackupPolicy
default DescribeBackupPolicyResponse describeBackupPolicy(Consumer<DescribeBackupPolicyRequest.Builder> describeBackupPolicyRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, PolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EfsException
Returns the backup policy for the specified EFS file system.
This is a convenience which creates an instance of the
DescribeBackupPolicyRequest.Builderavoiding the need to create one manually viaDescribeBackupPolicyRequest.builder()- Parameters:
describeBackupPolicyRequest- AConsumerthat will call methods onDescribeBackupPolicyRequest.Builderto create a request.- Returns:
- Result of the DescribeBackupPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.InternalServerErrorException- Returned if an error occurred on the server side.PolicyNotFoundException- Returned if the default file system policy is in effect for the EFS file system specified.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFileSystemPolicy
default DescribeFileSystemPolicyResponse describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, PolicyNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the
FileSystemPolicyfor the specified EFS file system.This operation requires permissions for the
elasticfilesystem:DescribeFileSystemPolicyaction.- Parameters:
describeFileSystemPolicyRequest-- Returns:
- Result of the DescribeFileSystemPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.PolicyNotFoundException- Returned if the default file system policy is in effect for the EFS file system specified.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFileSystemPolicy
default DescribeFileSystemPolicyResponse describeFileSystemPolicy(Consumer<DescribeFileSystemPolicyRequest.Builder> describeFileSystemPolicyRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, PolicyNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the
FileSystemPolicyfor the specified EFS file system.This operation requires permissions for the
elasticfilesystem:DescribeFileSystemPolicyaction.
This is a convenience which creates an instance of the
DescribeFileSystemPolicyRequest.Builderavoiding the need to create one manually viaDescribeFileSystemPolicyRequest.builder()- Parameters:
describeFileSystemPolicyRequest- AConsumerthat will call methods onDescribeFileSystemPolicyRequest.Builderto create a request.- Returns:
- Result of the DescribeFileSystemPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.PolicyNotFoundException- Returned if the default file system policy is in effect for the EFS file system specified.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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFileSystems
default DescribeFileSystemsResponse describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the description of a specific Amazon EFS file system if either the file system
CreationTokenor theFileSystemIdis 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
MaxItemsparameter 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 aNextMarker, an opaque token, in the response. In this case, you should send a subsequent request with theMarkerrequest parameter set to the value ofNextMarker.To retrieve a list of your file system descriptions, this operation is used in an iterative process, where
DescribeFileSystemsis called first without theMarkerand then the operation continues to call it with theMarkerparameter set to the value of theNextMarkerfrom the previous response until the response has noNextMarker.The order of file systems returned in the response of one
DescribeFileSystemscall and the order of file systems returned across the responses of a multi-call iteration is unspecified.This operation requires permissions for the
elasticfilesystem:DescribeFileSystemsaction.- Parameters:
describeFileSystemsRequest-- Returns:
- Result of the DescribeFileSystems operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFileSystems
default DescribeFileSystemsResponse describeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the description of a specific Amazon EFS file system if either the file system
CreationTokenor theFileSystemIdis 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
MaxItemsparameter 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 aNextMarker, an opaque token, in the response. In this case, you should send a subsequent request with theMarkerrequest parameter set to the value ofNextMarker.To retrieve a list of your file system descriptions, this operation is used in an iterative process, where
DescribeFileSystemsis called first without theMarkerand then the operation continues to call it with theMarkerparameter set to the value of theNextMarkerfrom the previous response until the response has noNextMarker.The order of file systems returned in the response of one
DescribeFileSystemscall and the order of file systems returned across the responses of a multi-call iteration is unspecified.This operation requires permissions for the
elasticfilesystem:DescribeFileSystemsaction.
This is a convenience which creates an instance of the
DescribeFileSystemsRequest.Builderavoiding the need to create one manually viaDescribeFileSystemsRequest.builder()- Parameters:
describeFileSystemsRequest- AConsumerthat will call methods onDescribeFileSystemsRequest.Builderto create a request.- Returns:
- Result of the DescribeFileSystems operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFileSystems
default DescribeFileSystemsResponse describeFileSystems() throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the description of a specific Amazon EFS file system if either the file system
CreationTokenor theFileSystemIdis 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
MaxItemsparameter 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 aNextMarker, an opaque token, in the response. In this case, you should send a subsequent request with theMarkerrequest parameter set to the value ofNextMarker.To retrieve a list of your file system descriptions, this operation is used in an iterative process, where
DescribeFileSystemsis called first without theMarkerand then the operation continues to call it with theMarkerparameter set to the value of theNextMarkerfrom the previous response until the response has noNextMarker.The order of file systems returned in the response of one
DescribeFileSystemscall and the order of file systems returned across the responses of a multi-call iteration is unspecified.This operation requires permissions for the
elasticfilesystem:DescribeFileSystemsaction.- Returns:
- Result of the DescribeFileSystems operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
describeFileSystems(DescribeFileSystemsRequest), AWS API Documentation
-
describeFileSystemsPaginator
default DescribeFileSystemsIterable describeFileSystemsPaginator() throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client .describeFileSystemsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
describeFileSystemsPaginator(DescribeFileSystemsRequest), AWS API Documentation
-
describeFileSystemsPaginator
default DescribeFileSystemsIterable describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client .describeFileSystemsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFileSystemsPaginator
default DescribeFileSystemsIterable describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeFileSystems(software.amazon.awssdk.services.efs.model.DescribeFileSystemsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client .describeFileSystemsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeFileSystemsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeFileSystemsRequest.builder()- Parameters:
describeFileSystemsRequest- AConsumerthat will call methods onDescribeFileSystemsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeLifecycleConfiguration
default DescribeLifecycleConfigurationResponse describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest) throws InternalServerErrorException, BadRequestException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the current
LifecycleConfigurationobject for the specified Amazon EFS file system. Lifecycle management uses theLifecycleConfigurationobject to identify when to move files between storage classes. For a file system without aLifecycleConfigurationobject, the call returns an empty array in the response.This operation requires permissions for the
elasticfilesystem:DescribeLifecycleConfigurationoperation.- Parameters:
describeLifecycleConfigurationRequest-- Returns:
- Result of the DescribeLifecycleConfiguration operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeLifecycleConfiguration
default DescribeLifecycleConfigurationResponse describeLifecycleConfiguration(Consumer<DescribeLifecycleConfigurationRequest.Builder> describeLifecycleConfigurationRequest) throws InternalServerErrorException, BadRequestException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Returns the current
LifecycleConfigurationobject for the specified Amazon EFS file system. Lifecycle management uses theLifecycleConfigurationobject to identify when to move files between storage classes. For a file system without aLifecycleConfigurationobject, the call returns an empty array in the response.This operation requires permissions for the
elasticfilesystem:DescribeLifecycleConfigurationoperation.
This is a convenience which creates an instance of the
DescribeLifecycleConfigurationRequest.Builderavoiding the need to create one manually viaDescribeLifecycleConfigurationRequest.builder()- Parameters:
describeLifecycleConfigurationRequest- AConsumerthat will call methods onDescribeLifecycleConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeLifecycleConfiguration operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeMountTargetSecurityGroups
default DescribeMountTargetSecurityGroupsResponse describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest) throws BadRequestException, InternalServerErrorException, MountTargetNotFoundException, IncorrectMountTargetStateException, AwsServiceException, SdkClientException, EfsException
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:DescribeMountTargetSecurityGroupsaction on the mount target's file system. -
ec2:DescribeNetworkInterfaceAttributeaction on the mount target's network interface.
- Parameters:
describeMountTargetSecurityGroupsRequest-- Returns:
- Result of the DescribeMountTargetSecurityGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeMountTargetSecurityGroups
default DescribeMountTargetSecurityGroupsResponse describeMountTargetSecurityGroups(Consumer<DescribeMountTargetSecurityGroupsRequest.Builder> describeMountTargetSecurityGroupsRequest) throws BadRequestException, InternalServerErrorException, MountTargetNotFoundException, IncorrectMountTargetStateException, AwsServiceException, SdkClientException, EfsException
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:DescribeMountTargetSecurityGroupsaction on the mount target's file system. -
ec2:DescribeNetworkInterfaceAttributeaction on the mount target's network interface.
This is a convenience which creates an instance of the
DescribeMountTargetSecurityGroupsRequest.Builderavoiding the need to create one manually viaDescribeMountTargetSecurityGroupsRequest.builder()- Parameters:
describeMountTargetSecurityGroupsRequest- AConsumerthat will call methods onDescribeMountTargetSecurityGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeMountTargetSecurityGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeMountTargets
default DescribeMountTargetsResponse describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, MountTargetNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:DescribeMountTargetsaction, on either the file system ID that you specify inFileSystemId, or on the file system of the mount target that you specify inMountTargetId.- Parameters:
describeMountTargetsRequest-- Returns:
- Result of the DescribeMountTargets operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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 specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeMountTargets
default DescribeMountTargetsResponse describeMountTargets(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, MountTargetNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:DescribeMountTargetsaction, on either the file system ID that you specify inFileSystemId, or on the file system of the mount target that you specify inMountTargetId.
This is a convenience which creates an instance of the
DescribeMountTargetsRequest.Builderavoiding the need to create one manually viaDescribeMountTargetsRequest.builder()- Parameters:
describeMountTargetsRequest- AConsumerthat will call methods onDescribeMountTargetsRequest.Builderto create a request.- Returns:
- Result of the DescribeMountTargets operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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 specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeMountTargetsPaginator
default DescribeMountTargetsIterable describeMountTargetsPaginator(DescribeMountTargetsRequest describeMountTargetsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, MountTargetNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client.describeMountTargetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client .describeMountTargetsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeMountTargetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client.describeMountTargetsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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 specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeMountTargetsPaginator
default DescribeMountTargetsIterable describeMountTargetsPaginator(Consumer<DescribeMountTargetsRequest.Builder> describeMountTargetsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, MountTargetNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeMountTargets(software.amazon.awssdk.services.efs.model.DescribeMountTargetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client.describeMountTargetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client .describeMountTargetsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeMountTargetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeMountTargetsIterable responses = client.describeMountTargetsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeMountTargetsRequest.builder()- Parameters:
describeMountTargetsRequest- AConsumerthat will call methods onDescribeMountTargetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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 specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReplicationConfigurations
default DescribeReplicationConfigurationsResponse describeReplicationConfigurations(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, ReplicationNotFoundException, ValidationException, AwsServiceException, SdkClientException, EfsException
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:
- Result of the DescribeReplicationConfigurations operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReplicationConfigurations
default DescribeReplicationConfigurationsResponse describeReplicationConfigurations(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, ReplicationNotFoundException, ValidationException, AwsServiceException, SdkClientException, EfsException
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.Builderavoiding the need to create one manually viaDescribeReplicationConfigurationsRequest.builder()- Parameters:
describeReplicationConfigurationsRequest- AConsumerthat will call methods onDescribeReplicationConfigurationsRequest.Builderto create a request.- Returns:
- Result of the DescribeReplicationConfigurations operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReplicationConfigurationsPaginator
default DescribeReplicationConfigurationsIterable describeReplicationConfigurationsPaginator(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, ReplicationNotFoundException, ValidationException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client.describeReplicationConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client .describeReplicationConfigurationsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client.describeReplicationConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReplicationConfigurationsPaginator
default DescribeReplicationConfigurationsIterable describeReplicationConfigurationsPaginator(Consumer<DescribeReplicationConfigurationsRequest.Builder> describeReplicationConfigurationsRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, ReplicationNotFoundException, ValidationException, AwsServiceException, SdkClientException, EfsException
This is a variant of
describeReplicationConfigurations(software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client.describeReplicationConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client .describeReplicationConfigurationsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeReplicationConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeReplicationConfigurationsIterable responses = client.describeReplicationConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeReplicationConfigurationsRequest.builder()- Parameters:
describeReplicationConfigurationsRequest- AConsumerthat will call methods onDescribeReplicationConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTags
@Deprecated default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Deprecated.Use ListTagsForResource.DEPRECATED - The
DescribeTagsaction is deprecated and not maintained. To view tags associated with EFS resources, use theListTagsForResourceAPI action.Returns the tags associated with a file system. The order of tags returned in the response of one
DescribeTagscall 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:DescribeTagsaction.- Parameters:
describeTagsRequest-- Returns:
- Result of the DescribeTags operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTags
@Deprecated default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Deprecated.Use ListTagsForResource.DEPRECATED - The
DescribeTagsaction is deprecated and not maintained. To view tags associated with EFS resources, use theListTagsForResourceAPI action.Returns the tags associated with a file system. The order of tags returned in the response of one
DescribeTagscall 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:DescribeTagsaction.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builderavoiding the need to create one manually viaDescribeTagsRequest.builder()- Parameters:
describeTagsRequest- AConsumerthat will call methods onDescribeTagsRequest.Builderto create a request.- Returns:
- Result of the DescribeTags operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTagsPaginator
@Deprecated default DescribeTagsIterable describeTagsPaginator(DescribeTagsRequest describeTagsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Deprecated.Use ListTagsForResource.This is a variant of
describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTagsPaginator
@Deprecated default DescribeTagsIterable describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AwsServiceException, SdkClientException, EfsException
Deprecated.Use ListTagsForResource.This is a variant of
describeTags(software.amazon.awssdk.services.efs.model.DescribeTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); for (software.amazon.awssdk.services.efs.model.DescribeTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeTagsRequest.builder()- Parameters:
describeTagsRequest- AConsumerthat will call methods onDescribeTagsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:DescribeAccessPointsaction.- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:DescribeAccessPointsaction.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.efs.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.efs.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.efs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyMountTargetSecurityGroups
default ModifyMountTargetSecurityGroupsResponse modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest) throws BadRequestException, InternalServerErrorException, MountTargetNotFoundException, IncorrectMountTargetStateException, SecurityGroupLimitExceededException, SecurityGroupNotFoundException, AwsServiceException, SdkClientException, EfsException
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
SecurityGroupsprovided 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 notdeleted.The operation requires permissions for the following actions:
-
elasticfilesystem:ModifyMountTargetSecurityGroupsaction on the mount target's file system. -
ec2:ModifyNetworkInterfaceAttributeaction on the mount target's network interface.
- Parameters:
modifyMountTargetSecurityGroupsRequest-- Returns:
- Result of the ModifyMountTargetSecurityGroups operation returned by the service.
- Throws:
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 size ofSecurityGroupsspecified in the request is greater than five.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
modifyMountTargetSecurityGroups
default ModifyMountTargetSecurityGroupsResponse modifyMountTargetSecurityGroups(Consumer<ModifyMountTargetSecurityGroupsRequest.Builder> modifyMountTargetSecurityGroupsRequest) throws BadRequestException, InternalServerErrorException, MountTargetNotFoundException, IncorrectMountTargetStateException, SecurityGroupLimitExceededException, SecurityGroupNotFoundException, AwsServiceException, SdkClientException, EfsException
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
SecurityGroupsprovided 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 notdeleted.The operation requires permissions for the following actions:
-
elasticfilesystem:ModifyMountTargetSecurityGroupsaction on the mount target's file system. -
ec2:ModifyNetworkInterfaceAttributeaction on the mount target's network interface.
This is a convenience which creates an instance of the
ModifyMountTargetSecurityGroupsRequest.Builderavoiding the need to create one manually viaModifyMountTargetSecurityGroupsRequest.builder()- Parameters:
modifyMountTargetSecurityGroupsRequest- AConsumerthat will call methods onModifyMountTargetSecurityGroupsRequest.Builderto create a request.- Returns:
- Result of the ModifyMountTargetSecurityGroups operation returned by the service.
- Throws:
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 size ofSecurityGroupsspecified in the request is greater than five.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
putAccountPreferences
default PutAccountPreferencesResponse putAccountPreferences(PutAccountPreferencesRequest putAccountPreferencesRequest) throws BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, EfsException
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:
- Result of the PutAccountPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAccountPreferences
default PutAccountPreferencesResponse putAccountPreferences(Consumer<PutAccountPreferencesRequest.Builder> putAccountPreferencesRequest) throws BadRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, EfsException
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.Builderavoiding the need to create one manually viaPutAccountPreferencesRequest.builder()- Parameters:
putAccountPreferencesRequest- AConsumerthat will call methods onPutAccountPreferencesRequest.Builderto create a request.- Returns:
- Result of the PutAccountPreferences operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putBackupPolicy
default PutBackupPolicyResponse putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest) throws BadRequestException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, InternalServerErrorException, ValidationException, AwsServiceException, SdkClientException, EfsException
Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
- Parameters:
putBackupPolicyRequest-- Returns:
- Result of the PutBackupPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
putBackupPolicy
default PutBackupPolicyResponse putBackupPolicy(Consumer<PutBackupPolicyRequest.Builder> putBackupPolicyRequest) throws BadRequestException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, InternalServerErrorException, ValidationException, AwsServiceException, SdkClientException, EfsException
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.Builderavoiding the need to create one manually viaPutBackupPolicyRequest.builder()- Parameters:
putBackupPolicyRequest- AConsumerthat will call methods onPutBackupPolicyRequest.Builderto create a request.- Returns:
- Result of the PutBackupPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
putFileSystemPolicy
default PutFileSystemPolicyResponse putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, InvalidPolicyException, IncorrectFileSystemLifeCycleStateException, AwsServiceException, SdkClientException, EfsException
Applies an Amazon EFS
FileSystemPolicyto 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:PutFileSystemPolicyaction.- Parameters:
putFileSystemPolicyRequest-- Returns:
- Result of the PutFileSystemPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.InvalidPolicyException- Returned if theFileSystemPolicyis 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.AwsServiceException- See Also:
- AWS API Documentation
-
putFileSystemPolicy
default PutFileSystemPolicyResponse putFileSystemPolicy(Consumer<PutFileSystemPolicyRequest.Builder> putFileSystemPolicyRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, InvalidPolicyException, IncorrectFileSystemLifeCycleStateException, AwsServiceException, SdkClientException, EfsException
Applies an Amazon EFS
FileSystemPolicyto 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:PutFileSystemPolicyaction.
This is a convenience which creates an instance of the
PutFileSystemPolicyRequest.Builderavoiding the need to create one manually viaPutFileSystemPolicyRequest.builder()- Parameters:
putFileSystemPolicyRequest- AConsumerthat will call methods onPutFileSystemPolicyRequest.Builderto create a request.- Returns:
- Result of the PutFileSystemPolicy operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.InvalidPolicyException- Returned if theFileSystemPolicyis 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.AwsServiceException- See Also:
- AWS API Documentation
-
putLifecycleConfiguration
default PutLifecycleConfigurationResponse putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, AwsServiceException, SdkClientException, EfsException
Use this action to manage storage for your file system. A
LifecycleConfigurationconsists of one or moreLifecyclePolicyobjects 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
LifecycleConfigurationobject already exists for the specified file system, aPutLifecycleConfigurationcall modifies the existing configuration. APutLifecycleConfigurationcall with an emptyLifecyclePoliciesarray in the request body deletes any existingLifecycleConfiguration. In the request, specify the following:-
The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.
-
A
LifecyclePoliciesarray ofLifecyclePolicyobjects that define when to move files to IA storage, to Archive storage, and back to primary storage.Amazon EFS requires that each
LifecyclePolicyobject have only have a single transition, so theLifecyclePoliciesarray needs to be structured with separateLifecyclePolicyobjects. See the example requests in the following section for more information.
This operation requires permissions for the
elasticfilesystem:PutLifecycleConfigurationoperation.To apply a
LifecycleConfigurationobject to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.- Parameters:
putLifecycleConfigurationRequest-- Returns:
- Result of the PutLifecycleConfiguration operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
putLifecycleConfiguration
default PutLifecycleConfigurationResponse putLifecycleConfiguration(Consumer<PutLifecycleConfigurationRequest.Builder> putLifecycleConfigurationRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, AwsServiceException, SdkClientException, EfsException
Use this action to manage storage for your file system. A
LifecycleConfigurationconsists of one or moreLifecyclePolicyobjects 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
LifecycleConfigurationobject already exists for the specified file system, aPutLifecycleConfigurationcall modifies the existing configuration. APutLifecycleConfigurationcall with an emptyLifecyclePoliciesarray in the request body deletes any existingLifecycleConfiguration. In the request, specify the following:-
The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.
-
A
LifecyclePoliciesarray ofLifecyclePolicyobjects that define when to move files to IA storage, to Archive storage, and back to primary storage.Amazon EFS requires that each
LifecyclePolicyobject have only have a single transition, so theLifecyclePoliciesarray needs to be structured with separateLifecyclePolicyobjects. See the example requests in the following section for more information.
This operation requires permissions for the
elasticfilesystem:PutLifecycleConfigurationoperation.To apply a
LifecycleConfigurationobject 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.Builderavoiding the need to create one manually viaPutLifecycleConfigurationRequest.builder()- Parameters:
putLifecycleConfigurationRequest- AConsumerthat will call methods onPutLifecycleConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutLifecycleConfiguration operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:TagResourceaction.- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:TagResourceaction.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:UntagResourceaction.- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, InternalServerErrorException, FileSystemNotFoundException, AccessPointNotFoundException, AwsServiceException, SdkClientException, EfsException
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:UntagResourceaction.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue doesn't exist in the requester's Amazon Web Services account.AccessPointNotFoundException- Returned if the specifiedAccessPointIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFileSystem
default UpdateFileSystemResponse updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest) throws BadRequestException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, InsufficientThroughputCapacityException, InternalServerErrorException, ThroughputLimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, EfsException
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
- Parameters:
updateFileSystemRequest-- Returns:
- Result of the UpdateFileSystem operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFileSystem
default UpdateFileSystemResponse updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest) throws BadRequestException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, InsufficientThroughputCapacityException, InternalServerErrorException, ThroughputLimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, EfsException
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.Builderavoiding the need to create one manually viaUpdateFileSystemRequest.builder()- Parameters:
updateFileSystemRequest- AConsumerthat will call methods onUpdateFileSystemRequest.Builderto create a request.- Returns:
- Result of the UpdateFileSystem operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFileSystemProtection
default UpdateFileSystemProtectionResponse updateFileSystemProtection(UpdateFileSystemProtectionRequest updateFileSystemProtectionRequest) throws BadRequestException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, InsufficientThroughputCapacityException, InternalServerErrorException, ThroughputLimitExceededException, ReplicationAlreadyExistsException, TooManyRequestsException, AwsServiceException, SdkClientException, EfsException
Updates protection on the file system.
This operation requires permissions for the
elasticfilesystem:UpdateFileSystemProtectionaction.- Parameters:
updateFileSystemProtectionRequest-- Returns:
- Result of the UpdateFileSystemProtection operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFileSystemProtection
default UpdateFileSystemProtectionResponse updateFileSystemProtection(Consumer<UpdateFileSystemProtectionRequest.Builder> updateFileSystemProtectionRequest) throws BadRequestException, FileSystemNotFoundException, IncorrectFileSystemLifeCycleStateException, InsufficientThroughputCapacityException, InternalServerErrorException, ThroughputLimitExceededException, ReplicationAlreadyExistsException, TooManyRequestsException, AwsServiceException, SdkClientException, EfsException
Updates protection on the file system.
This operation requires permissions for the
elasticfilesystem:UpdateFileSystemProtectionaction.
This is a convenience which creates an instance of the
UpdateFileSystemProtectionRequest.Builderavoiding the need to create one manually viaUpdateFileSystemProtectionRequest.builder()- Parameters:
updateFileSystemProtectionRequest- AConsumerthat will call methods onUpdateFileSystemProtectionRequest.Builderto create a request.- Returns:
- Result of the UpdateFileSystemProtection operation returned by the service.
- Throws:
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 specifiedFileSystemIdvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static EfsClient create()
Create aEfsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static EfsClientBuilder builder()
Create a builder that can be used to configure and create aEfsClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default EfsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-