/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the elasticfilesystem-2015-02-01.normal.json service model.
*/
using System;
using System.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.ElasticFileSystem.Model;
using Amazon.ElasticFileSystem.Model.Internal.MarshallTransformations;
using Amazon.ElasticFileSystem.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.ElasticFileSystem
{
///
/// Implementation for accessing ElasticFileSystem
///
/// 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.
///
///
public partial class AmazonElasticFileSystemClient : AmazonServiceClient, IAmazonElasticFileSystem
{
private static IServiceMetadata serviceMetadata = new AmazonElasticFileSystemMetadata();
private IElasticFileSystemPaginatorFactory _paginators;
///
/// Paginators for the service
///
public IElasticFileSystemPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new ElasticFileSystemPaginatorFactory(this);
}
return this._paginators;
}
}
#region Constructors
///
/// Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonElasticFileSystemClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonElasticFileSystemConfig()) { }
///
/// Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonElasticFileSystemClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonElasticFileSystemConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonElasticFileSystemClient Configuration Object
public AmazonElasticFileSystemClient(AmazonElasticFileSystemConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonElasticFileSystemClient with AWS Credentials
///
/// AWS Credentials
public AmazonElasticFileSystemClient(AWSCredentials credentials)
: this(credentials, new AmazonElasticFileSystemConfig())
{
}
///
/// Constructs AmazonElasticFileSystemClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonElasticFileSystemClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonElasticFileSystemConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonElasticFileSystemClient with AWS Credentials and an
/// AmazonElasticFileSystemClient Configuration object.
///
/// AWS Credentials
/// The AmazonElasticFileSystemClient Configuration Object
public AmazonElasticFileSystemClient(AWSCredentials credentials, AmazonElasticFileSystemConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonElasticFileSystemClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonElasticFileSystemConfig())
{
}
///
/// Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonElasticFileSystemClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonElasticFileSystemConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonElasticFileSystemClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonElasticFileSystemClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonElasticFileSystemClient Configuration Object
public AmazonElasticFileSystemClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonElasticFileSystemConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonElasticFileSystemClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonElasticFileSystemConfig())
{
}
///
/// Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonElasticFileSystemClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonElasticFileSystemConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonElasticFileSystemClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonElasticFileSystemClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonElasticFileSystemClient Configuration Object
public AmazonElasticFileSystemClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonElasticFileSystemConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.AddHandlerBefore(new Amazon.ElasticFileSystem.Internal.IdempotencyHandler());
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonElasticFileSystemEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region CreateAccessPoint
///
/// 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:CreateAccessPoint
/// action.
///
///
///
/// Access points can be tagged on creation. If tags are specified in the creation action,
/// IAM performs additional authorization on the elasticfilesystem:TagResource
/// action to verify if users have permissions to create tags. Therefore, you must grant
/// explicit permissions to use the elasticfilesystem:TagResource action.
/// For more information, see Granting
/// permissions to tag resources during creation.
///
///
/// Container for the necessary parameters to execute the CreateAccessPoint service method.
///
/// The response from the CreateAccessPoint service method, as returned by ElasticFileSystem.
///
/// Returned if the access point that you are trying to create already exists, with the
/// creation token you provided in the request.
///
///
/// 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.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned when the CreateAccessPoint API action is called too quickly
/// and the number of Access Points on the file system is nearing the limit
/// of 120.
///
/// REST API Reference for CreateAccessPoint Operation
public virtual CreateAccessPointResponse CreateAccessPoint(CreateAccessPointRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateAccessPointRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateAccessPointResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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:CreateAccessPoint
/// action.
///
///
///
/// Access points can be tagged on creation. If tags are specified in the creation action,
/// IAM performs additional authorization on the elasticfilesystem:TagResource
/// action to verify if users have permissions to create tags. Therefore, you must grant
/// explicit permissions to use the elasticfilesystem:TagResource action.
/// For more information, see Granting
/// permissions to tag resources during creation.
///
///
/// Container for the necessary parameters to execute the CreateAccessPoint service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateAccessPoint service method, as returned by ElasticFileSystem.
///
/// Returned if the access point that you are trying to create already exists, with the
/// creation token you provided in the request.
///
///
/// 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.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned when the CreateAccessPoint API action is called too quickly
/// and the number of Access Points on the file system is nearing the limit
/// of 120.
///
/// REST API Reference for CreateAccessPoint Operation
public virtual Task CreateAccessPointAsync(CreateAccessPointRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateAccessPointRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateAccessPointResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateFileSystem
///
/// Creates a new, empty file system. The operation requires a creation token in the request
/// that Amazon EFS uses to ensure idempotent creation (calling the operation with same
/// creation token has no effect). If a file system does not currently exist that is owned
/// by the caller's Amazon Web Services account with the specified creation token, this
/// operation does the following:
///
/// -
///
/// Creates a new, empty file system. The file system will have an Amazon EFS assigned
/// ID, and an initial lifecycle state
creating.
///
/// -
///
/// Returns with the description of the created file system.
///
///
///
/// Otherwise, this operation returns a FileSystemAlreadyExists error with
/// the ID of the existing file system.
///
///
///
/// For basic use cases, you can use a randomly generated UUID for the creation token.
///
///
///
/// The idempotent operation allows you to retry a CreateFileSystem call
/// without risk of creating an extra file system. This can happen when an initial call
/// fails in a way that leaves it uncertain whether or not a file system was actually
/// created. An example might be that a transport level timeout occurred or your connection
/// was reset. As long as you use the same creation token, if the initial call had succeeded
/// in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists
/// error.
///
///
///
/// For more information, see Creating
/// a file system in the Amazon EFS User Guide.
///
///
///
/// The CreateFileSystem call returns while the file system's lifecycle state
/// is still creating. You can check the file system creation status by calling
/// the DescribeFileSystems operation, which among other things returns the file
/// system state.
///
///
///
/// This operation accepts an optional PerformanceMode parameter that you
/// choose for your file system. We recommend generalPurpose performance
/// mode for most file systems. File systems using the maxIO performance
/// mode can scale to higher levels of aggregate throughput and operations per second
/// with a tradeoff of slightly higher latencies for most file operations. The performance
/// mode can't be changed after the file system has been created. For more information,
/// see Amazon
/// EFS performance modes.
///
///
///
/// You can set the throughput mode for the file system using the ThroughputMode
/// parameter.
///
///
///
/// After the file system is fully created, Amazon EFS sets its lifecycle state to available,
/// at which point you can create one or more mount targets for the file system in your
/// VPC. For more information, see CreateMountTarget. You mount your Amazon EFS
/// file system on an EC2 instances in your VPC by using the mount target. For more information,
/// see Amazon EFS:
/// How it Works.
///
///
///
/// This operation requires permissions for the elasticfilesystem:CreateFileSystem
/// action.
///
///
///
/// File systems can be tagged on creation. If tags are specified in the creation action,
/// IAM performs additional authorization on the elasticfilesystem:TagResource
/// action to verify if users have permissions to create tags. Therefore, you must grant
/// explicit permissions to use the elasticfilesystem:TagResource action.
/// For more information, see Granting
/// permissions to tag resources during creation.
///
///
/// A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
///
/// The response from the CreateFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the file system you are trying to create already exists, with the creation
/// token you provided.
///
///
/// Returned if the Amazon Web Services account has already created the maximum number
/// of file systems allowed per account.
///
///
/// 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.
///
///
/// Returned if an error occurred on the server side.
///
///
/// 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.
///
///
/// Returned if the requested Amazon EFS functionality is not available in the specified
/// Availability Zone.
///
/// REST API Reference for CreateFileSystem Operation
public virtual CreateFileSystemResponse CreateFileSystem(string creationToken)
{
var request = new CreateFileSystemRequest();
request.CreationToken = creationToken;
return CreateFileSystem(request);
}
///
/// Creates a new, empty file system. The operation requires a creation token in the request
/// that Amazon EFS uses to ensure idempotent creation (calling the operation with same
/// creation token has no effect). If a file system does not currently exist that is owned
/// by the caller's Amazon Web Services account with the specified creation token, this
/// operation does the following:
///
/// -
///
/// Creates a new, empty file system. The file system will have an Amazon EFS assigned
/// ID, and an initial lifecycle state
creating.
///
/// -
///
/// Returns with the description of the created file system.
///
///
///
/// Otherwise, this operation returns a FileSystemAlreadyExists error with
/// the ID of the existing file system.
///
///
///
/// For basic use cases, you can use a randomly generated UUID for the creation token.
///
///
///
/// The idempotent operation allows you to retry a CreateFileSystem call
/// without risk of creating an extra file system. This can happen when an initial call
/// fails in a way that leaves it uncertain whether or not a file system was actually
/// created. An example might be that a transport level timeout occurred or your connection
/// was reset. As long as you use the same creation token, if the initial call had succeeded
/// in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists
/// error.
///
///
///
/// For more information, see Creating
/// a file system in the Amazon EFS User Guide.
///
///
///
/// The CreateFileSystem call returns while the file system's lifecycle state
/// is still creating. You can check the file system creation status by calling
/// the DescribeFileSystems operation, which among other things returns the file
/// system state.
///
///
///
/// This operation accepts an optional PerformanceMode parameter that you
/// choose for your file system. We recommend generalPurpose performance
/// mode for most file systems. File systems using the maxIO performance
/// mode can scale to higher levels of aggregate throughput and operations per second
/// with a tradeoff of slightly higher latencies for most file operations. The performance
/// mode can't be changed after the file system has been created. For more information,
/// see Amazon
/// EFS performance modes.
///
///
///
/// You can set the throughput mode for the file system using the ThroughputMode
/// parameter.
///
///
///
/// After the file system is fully created, Amazon EFS sets its lifecycle state to available,
/// at which point you can create one or more mount targets for the file system in your
/// VPC. For more information, see CreateMountTarget. You mount your Amazon EFS
/// file system on an EC2 instances in your VPC by using the mount target. For more information,
/// see Amazon EFS:
/// How it Works.
///
///
///
/// This operation requires permissions for the elasticfilesystem:CreateFileSystem
/// action.
///
///
///
/// File systems can be tagged on creation. If tags are specified in the creation action,
/// IAM performs additional authorization on the elasticfilesystem:TagResource
/// action to verify if users have permissions to create tags. Therefore, you must grant
/// explicit permissions to use the elasticfilesystem:TagResource action.
/// For more information, see Granting
/// permissions to tag resources during creation.
///
///
/// Container for the necessary parameters to execute the CreateFileSystem service method.
///
/// The response from the CreateFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the file system you are trying to create already exists, with the creation
/// token you provided.
///
///
/// Returned if the Amazon Web Services account has already created the maximum number
/// of file systems allowed per account.
///
///
/// 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.
///
///
/// Returned if an error occurred on the server side.
///
///
/// 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.
///
///
/// Returned if the requested Amazon EFS functionality is not available in the specified
/// Availability Zone.
///
/// REST API Reference for CreateFileSystem Operation
public virtual CreateFileSystemResponse CreateFileSystem(CreateFileSystemRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateFileSystemRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateFileSystemResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a new, empty file system. The operation requires a creation token in the request
/// that Amazon EFS uses to ensure idempotent creation (calling the operation with same
/// creation token has no effect). If a file system does not currently exist that is owned
/// by the caller's Amazon Web Services account with the specified creation token, this
/// operation does the following:
///
/// -
///
/// Creates a new, empty file system. The file system will have an Amazon EFS assigned
/// ID, and an initial lifecycle state
creating.
///
/// -
///
/// Returns with the description of the created file system.
///
///
///
/// Otherwise, this operation returns a FileSystemAlreadyExists error with
/// the ID of the existing file system.
///
///
///
/// For basic use cases, you can use a randomly generated UUID for the creation token.
///
///
///
/// The idempotent operation allows you to retry a CreateFileSystem call
/// without risk of creating an extra file system. This can happen when an initial call
/// fails in a way that leaves it uncertain whether or not a file system was actually
/// created. An example might be that a transport level timeout occurred or your connection
/// was reset. As long as you use the same creation token, if the initial call had succeeded
/// in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists
/// error.
///
///
///
/// For more information, see Creating
/// a file system in the Amazon EFS User Guide.
///
///
///
/// The CreateFileSystem call returns while the file system's lifecycle state
/// is still creating. You can check the file system creation status by calling
/// the DescribeFileSystems operation, which among other things returns the file
/// system state.
///
///
///
/// This operation accepts an optional PerformanceMode parameter that you
/// choose for your file system. We recommend generalPurpose performance
/// mode for most file systems. File systems using the maxIO performance
/// mode can scale to higher levels of aggregate throughput and operations per second
/// with a tradeoff of slightly higher latencies for most file operations. The performance
/// mode can't be changed after the file system has been created. For more information,
/// see Amazon
/// EFS performance modes.
///
///
///
/// You can set the throughput mode for the file system using the ThroughputMode
/// parameter.
///
///
///
/// After the file system is fully created, Amazon EFS sets its lifecycle state to available,
/// at which point you can create one or more mount targets for the file system in your
/// VPC. For more information, see CreateMountTarget. You mount your Amazon EFS
/// file system on an EC2 instances in your VPC by using the mount target. For more information,
/// see Amazon EFS:
/// How it Works.
///
///
///
/// This operation requires permissions for the elasticfilesystem:CreateFileSystem
/// action.
///
///
///
/// File systems can be tagged on creation. If tags are specified in the creation action,
/// IAM performs additional authorization on the elasticfilesystem:TagResource
/// action to verify if users have permissions to create tags. Therefore, you must grant
/// explicit permissions to use the elasticfilesystem:TagResource action.
/// For more information, see Granting
/// permissions to tag resources during creation.
///
///
/// A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the file system you are trying to create already exists, with the creation
/// token you provided.
///
///
/// Returned if the Amazon Web Services account has already created the maximum number
/// of file systems allowed per account.
///
///
/// 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.
///
///
/// Returned if an error occurred on the server side.
///
///
/// 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.
///
///
/// Returned if the requested Amazon EFS functionality is not available in the specified
/// Availability Zone.
///
/// REST API Reference for CreateFileSystem Operation
public virtual Task CreateFileSystemAsync(string creationToken, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new CreateFileSystemRequest();
request.CreationToken = creationToken;
return CreateFileSystemAsync(request, cancellationToken);
}
///
/// Creates a new, empty file system. The operation requires a creation token in the request
/// that Amazon EFS uses to ensure idempotent creation (calling the operation with same
/// creation token has no effect). If a file system does not currently exist that is owned
/// by the caller's Amazon Web Services account with the specified creation token, this
/// operation does the following:
///
/// -
///
/// Creates a new, empty file system. The file system will have an Amazon EFS assigned
/// ID, and an initial lifecycle state
creating.
///
/// -
///
/// Returns with the description of the created file system.
///
///
///
/// Otherwise, this operation returns a FileSystemAlreadyExists error with
/// the ID of the existing file system.
///
///
///
/// For basic use cases, you can use a randomly generated UUID for the creation token.
///
///
///
/// The idempotent operation allows you to retry a CreateFileSystem call
/// without risk of creating an extra file system. This can happen when an initial call
/// fails in a way that leaves it uncertain whether or not a file system was actually
/// created. An example might be that a transport level timeout occurred or your connection
/// was reset. As long as you use the same creation token, if the initial call had succeeded
/// in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists
/// error.
///
///
///
/// For more information, see Creating
/// a file system in the Amazon EFS User Guide.
///
///
///
/// The CreateFileSystem call returns while the file system's lifecycle state
/// is still creating. You can check the file system creation status by calling
/// the DescribeFileSystems operation, which among other things returns the file
/// system state.
///
///
///
/// This operation accepts an optional PerformanceMode parameter that you
/// choose for your file system. We recommend generalPurpose performance
/// mode for most file systems. File systems using the maxIO performance
/// mode can scale to higher levels of aggregate throughput and operations per second
/// with a tradeoff of slightly higher latencies for most file operations. The performance
/// mode can't be changed after the file system has been created. For more information,
/// see Amazon
/// EFS performance modes.
///
///
///
/// You can set the throughput mode for the file system using the ThroughputMode
/// parameter.
///
///
///
/// After the file system is fully created, Amazon EFS sets its lifecycle state to available,
/// at which point you can create one or more mount targets for the file system in your
/// VPC. For more information, see CreateMountTarget. You mount your Amazon EFS
/// file system on an EC2 instances in your VPC by using the mount target. For more information,
/// see Amazon EFS:
/// How it Works.
///
///
///
/// This operation requires permissions for the elasticfilesystem:CreateFileSystem
/// action.
///
///
///
/// File systems can be tagged on creation. If tags are specified in the creation action,
/// IAM performs additional authorization on the elasticfilesystem:TagResource
/// action to verify if users have permissions to create tags. Therefore, you must grant
/// explicit permissions to use the elasticfilesystem:TagResource action.
/// For more information, see Granting
/// permissions to tag resources during creation.
///
///
/// Container for the necessary parameters to execute the CreateFileSystem service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the file system you are trying to create already exists, with the creation
/// token you provided.
///
///
/// Returned if the Amazon Web Services account has already created the maximum number
/// of file systems allowed per account.
///
///
/// 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.
///
///
/// Returned if an error occurred on the server side.
///
///
/// 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.
///
///
/// Returned if the requested Amazon EFS functionality is not available in the specified
/// Availability Zone.
///
/// REST API Reference for CreateFileSystem Operation
public virtual Task CreateFileSystemAsync(CreateFileSystemRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateFileSystemRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateFileSystemResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateMountTarget
///
/// 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 an EFS file system using One Zone storage
/// classes. You must create that mount target in the same Availability Zone in which
/// the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId
/// properties in the DescribeFileSystems response object to get this information.
/// Use the subnetId associated with the file system's Availability Zone
/// when creating the mount target.
///
///
///
/// For more information, see Amazon
/// EFS: How it Works.
///
///
///
/// To create a mount target for a file system, the file system's lifecycle state must
/// be available. For more information, see DescribeFileSystems.
///
///
///
/// In the request, provide the following:
///
/// -
///
/// The file system ID for which you are creating the mount target.
///
///
-
///
/// A subnet ID, which determines the following:
///
///
-
///
/// The VPC in which Amazon EFS creates the mount target
///
///
-
///
/// The Availability Zone in which Amazon EFS creates the mount target
///
///
-
///
/// The IP address range from which Amazon EFS selects the IP address of the mount target
/// (if you don't specify an IP address in the request)
///
///
///
/// After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId
/// and an IpAddress. You use this IP address when mounting the file system
/// in an EC2 instance. You can also use the mount target's DNS name when mounting the
/// file system. The EC2 instance on which you mount the file system by using the mount
/// target can resolve the mount target's DNS name to its IP address. For more information,
/// see How
/// it Works: Implementation Overview.
///
///
///
/// Note that you can create mount targets for a file system in only one VPC, and there
/// can be only one mount target per Availability Zone. That is, if the file system already
/// has one or more mount targets created for it, the subnet specified in the request
/// to add another mount target must meet the following requirements:
///
/// -
///
/// Must belong to the same VPC as the subnets of the existing mount targets
///
///
-
///
/// Must not be in the same Availability Zone as any of the subnets of the existing mount
/// targets
///
///
///
/// If the request satisfies the requirements, Amazon EFS does the following:
///
/// -
///
/// Creates a new mount target in the specified subnet.
///
///
-
///
/// Also creates a new network interface in the subnet as follows:
///
///
-
///
/// If the request provides an
IpAddress, Amazon EFS assigns that IP address
/// to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet
/// (in the same way that the Amazon EC2 CreateNetworkInterface call does
/// when a request does not specify a primary private IP address).
///
/// -
///
/// If the request provides
SecurityGroups, this network interface is associated
/// with those security groups. Otherwise, it belongs to the default security group for
/// the subnet's VPC.
///
/// -
///
/// Assigns the description
Mount target fsmt-id for file system fs-id
/// where fsmt-id is the mount target ID, and fs-id
/// is the FileSystemId.
///
/// -
///
/// Sets the
requesterManaged property of the network interface to true,
/// and the requesterId value to EFS.
///
///
///
/// Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface.
/// After the network interface is created, Amazon EFS sets the NetworkInterfaceId
/// field in the mount target's description to the network interface ID, and the IpAddress
/// field to its address. If network interface creation fails, the entire CreateMountTarget
/// operation fails.
///
///
///
/// The CreateMountTarget call returns only after creating the network interface,
/// but while the mount target state is still creating, you can check the
/// mount target creation status by calling the DescribeMountTargets operation,
/// which among other things returns the mount target state.
///
///
///
/// We recommend that you create a mount target in each of the Availability Zones. There
/// are cost considerations for using a file system in an Availability Zone through a
/// mount target created in another Availability Zone. For more information, see Amazon
/// EFS. 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
///
///
///
/// Container for the necessary parameters to execute the CreateMountTarget service method.
///
/// The response from the CreateMountTarget service method, as returned by ElasticFileSystem.
///
/// 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.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the request specified an IpAddress that is already in use
/// in the subnet.
///
///
/// Returned if the mount target would violate one of the specified restrictions based
/// on the file system's existing mount targets.
///
///
/// 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).
///
///
/// Returned if IpAddress was not specified in the request and there are
/// no free IP addresses in the subnet.
///
///
/// Returned if the size of SecurityGroups specified in the request is greater
/// than five.
///
///
/// Returned if one of the specified security groups doesn't exist in the subnet's virtual
/// private cloud (VPC).
///
///
/// Returned if there is no subnet with ID SubnetId provided in the request.
///
///
/// Returned if the requested Amazon EFS functionality is not available in the specified
/// Availability Zone.
///
/// REST API Reference for CreateMountTarget Operation
public virtual CreateMountTargetResponse CreateMountTarget(CreateMountTargetRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateMountTargetRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateMountTargetResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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 an EFS file system using One Zone storage
/// classes. You must create that mount target in the same Availability Zone in which
/// the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId
/// properties in the DescribeFileSystems response object to get this information.
/// Use the subnetId associated with the file system's Availability Zone
/// when creating the mount target.
///
///
///
/// For more information, see Amazon
/// EFS: How it Works.
///
///
///
/// To create a mount target for a file system, the file system's lifecycle state must
/// be available. For more information, see DescribeFileSystems.
///
///
///
/// In the request, provide the following:
///
/// -
///
/// The file system ID for which you are creating the mount target.
///
///
-
///
/// A subnet ID, which determines the following:
///
///
-
///
/// The VPC in which Amazon EFS creates the mount target
///
///
-
///
/// The Availability Zone in which Amazon EFS creates the mount target
///
///
-
///
/// The IP address range from which Amazon EFS selects the IP address of the mount target
/// (if you don't specify an IP address in the request)
///
///
///
/// After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId
/// and an IpAddress. You use this IP address when mounting the file system
/// in an EC2 instance. You can also use the mount target's DNS name when mounting the
/// file system. The EC2 instance on which you mount the file system by using the mount
/// target can resolve the mount target's DNS name to its IP address. For more information,
/// see How
/// it Works: Implementation Overview.
///
///
///
/// Note that you can create mount targets for a file system in only one VPC, and there
/// can be only one mount target per Availability Zone. That is, if the file system already
/// has one or more mount targets created for it, the subnet specified in the request
/// to add another mount target must meet the following requirements:
///
/// -
///
/// Must belong to the same VPC as the subnets of the existing mount targets
///
///
-
///
/// Must not be in the same Availability Zone as any of the subnets of the existing mount
/// targets
///
///
///
/// If the request satisfies the requirements, Amazon EFS does the following:
///
/// -
///
/// Creates a new mount target in the specified subnet.
///
///
-
///
/// Also creates a new network interface in the subnet as follows:
///
///
-
///
/// If the request provides an
IpAddress, Amazon EFS assigns that IP address
/// to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet
/// (in the same way that the Amazon EC2 CreateNetworkInterface call does
/// when a request does not specify a primary private IP address).
///
/// -
///
/// If the request provides
SecurityGroups, this network interface is associated
/// with those security groups. Otherwise, it belongs to the default security group for
/// the subnet's VPC.
///
/// -
///
/// Assigns the description
Mount target fsmt-id for file system fs-id
/// where fsmt-id is the mount target ID, and fs-id
/// is the FileSystemId.
///
/// -
///
/// Sets the
requesterManaged property of the network interface to true,
/// and the requesterId value to EFS.
///
///
///
/// Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface.
/// After the network interface is created, Amazon EFS sets the NetworkInterfaceId
/// field in the mount target's description to the network interface ID, and the IpAddress
/// field to its address. If network interface creation fails, the entire CreateMountTarget
/// operation fails.
///
///
///
/// The CreateMountTarget call returns only after creating the network interface,
/// but while the mount target state is still creating, you can check the
/// mount target creation status by calling the DescribeMountTargets operation,
/// which among other things returns the mount target state.
///
///
///
/// We recommend that you create a mount target in each of the Availability Zones. There
/// are cost considerations for using a file system in an Availability Zone through a
/// mount target created in another Availability Zone. For more information, see Amazon
/// EFS. 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
///
///
///
/// Container for the necessary parameters to execute the CreateMountTarget service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateMountTarget service method, as returned by ElasticFileSystem.
///
/// 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.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the request specified an IpAddress that is already in use
/// in the subnet.
///
///
/// Returned if the mount target would violate one of the specified restrictions based
/// on the file system's existing mount targets.
///
///
/// 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).
///
///
/// Returned if IpAddress was not specified in the request and there are
/// no free IP addresses in the subnet.
///
///
/// Returned if the size of SecurityGroups specified in the request is greater
/// than five.
///
///
/// Returned if one of the specified security groups doesn't exist in the subnet's virtual
/// private cloud (VPC).
///
///
/// Returned if there is no subnet with ID SubnetId provided in the request.
///
///
/// Returned if the requested Amazon EFS functionality is not available in the specified
/// Availability Zone.
///
/// REST API Reference for CreateMountTarget Operation
public virtual Task CreateMountTargetAsync(CreateMountTargetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateMountTargetRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateMountTargetResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateReplicationConfiguration
///
/// Creates a replication configuration that replicates an existing EFS file system to
/// a new, read-only file system. For more information, see Amazon
/// EFS replication in the Amazon EFS User Guide. The replication configuration
/// specifies the following:
///
/// -
///
/// Source file system - An existing EFS file system that you want replicated.
/// The source file system cannot be a destination file system in an existing replication
/// configuration.
///
///
-
///
/// Destination file system configuration - The configuration of the destination
/// file system to which the source file system will be replicated. There can only be
/// one destination file system in a replication configuration. The destination file system
/// configuration consists of the following properties:
///
///
-
///
/// Amazon Web Services Region - The Amazon Web Services Region in which the destination
/// file system is created. Amazon EFS replication is available in all Amazon Web Services
/// Regions that Amazon EFS is available in, except Africa (Cape Town), Asia Pacific (Hong
/// Kong), Asia Pacific (Jakarta), Europe (Milan), and Middle East (Bahrain).
///
///
-
///
/// Availability Zone - If you want the destination file system to use EFS One
/// Zone availability and durability, you must specify the Availability Zone to create
/// the file system in. For more information about EFS storage classes, see
/// Amazon EFS storage classes in the Amazon EFS User Guide.
///
///
-
///
/// Encryption - All destination file systems are created with encryption at rest
/// enabled. You can specify the Key Management Service (KMS) key that is used to encrypt
/// the destination file system. If you don't specify a KMS key, your service-managed
/// KMS key for Amazon EFS is used.
///
///
///
/// After the file system is created, you cannot change the KMS key.
///
///
///
/// The following properties are set by default:
///
/// -
///
/// Performance mode - The destination file system's performance mode matches
/// that of the source file system, unless the destination file system uses EFS One Zone
/// storage. In that case, the General Purpose performance mode is used. The performance
/// mode cannot be changed.
///
///
-
///
/// Throughput mode - The destination file system's throughput mode matches that
/// of the source file system. After the file system is created, you can modify the throughput
/// mode.
///
///
///
/// The following properties are turned off by default:
///
/// -
///
/// Lifecycle management - EFS lifecycle management and EFS Intelligent-Tiering
/// are not enabled on the destination file system. After the destination file system
/// is created, you can enable EFS lifecycle management and EFS Intelligent-Tiering.
///
///
-
///
/// Automatic backups - Automatic daily backups not enabled on the destination
/// file system. After the file system is created, you can change this setting.
///
///
///
/// For more information, see Amazon
/// EFS replication in the Amazon EFS User Guide.
///
///
/// Container for the necessary parameters to execute the CreateReplicationConfiguration service method.
///
/// The response from the CreateReplicationConfiguration service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the Amazon Web Services account has already created the maximum number
/// of file systems allowed per account.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// 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.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the specified file system does not have a replication configuration.
///
///
/// 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.
///
///
/// Returned if the requested Amazon EFS functionality is not available in the specified
/// Availability Zone.
///
///
/// Returned if the Backup service is not available in the Amazon Web Services Region
/// in which the request was made.
///
/// REST API Reference for CreateReplicationConfiguration Operation
public virtual CreateReplicationConfigurationResponse CreateReplicationConfiguration(CreateReplicationConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateReplicationConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateReplicationConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a replication configuration that replicates an existing EFS file system to
/// a new, read-only file system. For more information, see Amazon
/// EFS replication in the Amazon EFS User Guide. The replication configuration
/// specifies the following:
///
/// -
///
/// Source file system - An existing EFS file system that you want replicated.
/// The source file system cannot be a destination file system in an existing replication
/// configuration.
///
///
-
///
/// Destination file system configuration - The configuration of the destination
/// file system to which the source file system will be replicated. There can only be
/// one destination file system in a replication configuration. The destination file system
/// configuration consists of the following properties:
///
///
-
///
/// Amazon Web Services Region - The Amazon Web Services Region in which the destination
/// file system is created. Amazon EFS replication is available in all Amazon Web Services
/// Regions that Amazon EFS is available in, except Africa (Cape Town), Asia Pacific (Hong
/// Kong), Asia Pacific (Jakarta), Europe (Milan), and Middle East (Bahrain).
///
///
-
///
/// Availability Zone - If you want the destination file system to use EFS One
/// Zone availability and durability, you must specify the Availability Zone to create
/// the file system in. For more information about EFS storage classes, see
/// Amazon EFS storage classes in the Amazon EFS User Guide.
///
///
-
///
/// Encryption - All destination file systems are created with encryption at rest
/// enabled. You can specify the Key Management Service (KMS) key that is used to encrypt
/// the destination file system. If you don't specify a KMS key, your service-managed
/// KMS key for Amazon EFS is used.
///
///
///
/// After the file system is created, you cannot change the KMS key.
///
///
///
/// The following properties are set by default:
///
/// -
///
/// Performance mode - The destination file system's performance mode matches
/// that of the source file system, unless the destination file system uses EFS One Zone
/// storage. In that case, the General Purpose performance mode is used. The performance
/// mode cannot be changed.
///
///
-
///
/// Throughput mode - The destination file system's throughput mode matches that
/// of the source file system. After the file system is created, you can modify the throughput
/// mode.
///
///
///
/// The following properties are turned off by default:
///
/// -
///
/// Lifecycle management - EFS lifecycle management and EFS Intelligent-Tiering
/// are not enabled on the destination file system. After the destination file system
/// is created, you can enable EFS lifecycle management and EFS Intelligent-Tiering.
///
///
-
///
/// Automatic backups - Automatic daily backups not enabled on the destination
/// file system. After the file system is created, you can change this setting.
///
///
///
/// For more information, see Amazon
/// EFS replication in the Amazon EFS User Guide.
///
///
/// Container for the necessary parameters to execute the CreateReplicationConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateReplicationConfiguration service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the Amazon Web Services account has already created the maximum number
/// of file systems allowed per account.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// 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.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the specified file system does not have a replication configuration.
///
///
/// 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.
///
///
/// Returned if the requested Amazon EFS functionality is not available in the specified
/// Availability Zone.
///
///
/// Returned if the Backup service is not available in the Amazon Web Services Region
/// in which the request was made.
///
/// REST API Reference for CreateReplicationConfiguration Operation
public virtual Task CreateReplicationConfigurationAsync(CreateReplicationConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateReplicationConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateReplicationConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateTags
///
///
///
/// DEPRECATED - CreateTags is deprecated and not maintained. To create tags
/// for EFS resources, use the API action.
///
///
///
/// Creates or overwrites tags associated with a file system. Each tag is a key-value
/// pair. If a tag key specified in the request already exists on the file system, this
/// operation overwrites its value with the value provided in the request. If you add
/// the Name tag to your file system, Amazon EFS returns it in the response
/// to the DescribeFileSystems operation.
///
///
///
/// This operation requires permission for the elasticfilesystem:CreateTags
/// action.
///
///
/// Container for the necessary parameters to execute the CreateTags service method.
///
/// The response from the CreateTags service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for CreateTags Operation
[Obsolete("Use TagResource.")]
public virtual CreateTagsResponse CreateTags(CreateTagsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateTagsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
///
///
/// DEPRECATED - CreateTags is deprecated and not maintained. To create tags
/// for EFS resources, use the API action.
///
///
///
/// Creates or overwrites tags associated with a file system. Each tag is a key-value
/// pair. If a tag key specified in the request already exists on the file system, this
/// operation overwrites its value with the value provided in the request. If you add
/// the Name tag to your file system, Amazon EFS returns it in the response
/// to the DescribeFileSystems operation.
///
///
///
/// This operation requires permission for the elasticfilesystem:CreateTags
/// action.
///
///
/// Container for the necessary parameters to execute the CreateTags service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateTags service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for CreateTags Operation
[Obsolete("Use TagResource.")]
public virtual Task CreateTagsAsync(CreateTagsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateTagsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteAccessPoint
///
/// Deletes the specified access point. After deletion is complete, new clients can no
/// longer connect to the access points. Clients connected to the access point at the
/// time of deletion will continue to function until they terminate their connection.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteAccessPoint
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteAccessPoint service method.
///
/// The response from the DeleteAccessPoint service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteAccessPoint Operation
public virtual DeleteAccessPointResponse DeleteAccessPoint(DeleteAccessPointRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteAccessPointRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteAccessPointResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the specified access point. After deletion is complete, new clients can no
/// longer connect to the access points. Clients connected to the access point at the
/// time of deletion will continue to function until they terminate their connection.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteAccessPoint
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteAccessPoint service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteAccessPoint service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteAccessPoint Operation
public virtual Task DeleteAccessPointAsync(DeleteAccessPointRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteAccessPointRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteAccessPointResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteFileSystem
///
/// Deletes a file system, permanently severing access to its contents. Upon return, the
/// file system no longer exists and you can't access any contents of the deleted file
/// system.
///
///
///
/// You need to manually delete mount targets attached to a file system before you can
/// delete an EFS file system. This step is performed for you when you use the Amazon
/// Web Services console to delete a file system.
///
///
///
/// You cannot delete a file system that is part of an EFS Replication configuration.
/// You need to delete the replication configuration first.
///
///
///
/// You can't delete a file system that is in use. That is, if the file system has any
/// mount targets, you must first delete them. For more information, see DescribeMountTargets
/// and DeleteMountTarget.
///
///
///
/// The DeleteFileSystem call returns while the file system state is still
/// deleting. You can check the file system deletion status by calling the
/// DescribeFileSystems operation, which returns a list of file systems in your
/// account. If you pass file system ID or creation token for the deleted file system,
/// the DescribeFileSystems returns a 404 FileSystemNotFound error.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteFileSystem
/// action.
///
///
/// The ID of the file system you want to delete.
///
/// The response from the DeleteFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if a file system has mount targets.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteFileSystem Operation
public virtual DeleteFileSystemResponse DeleteFileSystem(string fileSystemId)
{
var request = new DeleteFileSystemRequest();
request.FileSystemId = fileSystemId;
return DeleteFileSystem(request);
}
///
/// Deletes a file system, permanently severing access to its contents. Upon return, the
/// file system no longer exists and you can't access any contents of the deleted file
/// system.
///
///
///
/// You need to manually delete mount targets attached to a file system before you can
/// delete an EFS file system. This step is performed for you when you use the Amazon
/// Web Services console to delete a file system.
///
///
///
/// You cannot delete a file system that is part of an EFS Replication configuration.
/// You need to delete the replication configuration first.
///
///
///
/// You can't delete a file system that is in use. That is, if the file system has any
/// mount targets, you must first delete them. For more information, see DescribeMountTargets
/// and DeleteMountTarget.
///
///
///
/// The DeleteFileSystem call returns while the file system state is still
/// deleting. You can check the file system deletion status by calling the
/// DescribeFileSystems operation, which returns a list of file systems in your
/// account. If you pass file system ID or creation token for the deleted file system,
/// the DescribeFileSystems returns a 404 FileSystemNotFound error.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteFileSystem
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteFileSystem service method.
///
/// The response from the DeleteFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if a file system has mount targets.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteFileSystem Operation
public virtual DeleteFileSystemResponse DeleteFileSystem(DeleteFileSystemRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteFileSystemRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteFileSystemResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a file system, permanently severing access to its contents. Upon return, the
/// file system no longer exists and you can't access any contents of the deleted file
/// system.
///
///
///
/// You need to manually delete mount targets attached to a file system before you can
/// delete an EFS file system. This step is performed for you when you use the Amazon
/// Web Services console to delete a file system.
///
///
///
/// You cannot delete a file system that is part of an EFS Replication configuration.
/// You need to delete the replication configuration first.
///
///
///
/// You can't delete a file system that is in use. That is, if the file system has any
/// mount targets, you must first delete them. For more information, see DescribeMountTargets
/// and DeleteMountTarget.
///
///
///
/// The DeleteFileSystem call returns while the file system state is still
/// deleting. You can check the file system deletion status by calling the
/// DescribeFileSystems operation, which returns a list of file systems in your
/// account. If you pass file system ID or creation token for the deleted file system,
/// the DescribeFileSystems returns a 404 FileSystemNotFound error.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteFileSystem
/// action.
///
///
/// The ID of the file system you want to delete.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if a file system has mount targets.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteFileSystem Operation
public virtual Task DeleteFileSystemAsync(string fileSystemId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteFileSystemRequest();
request.FileSystemId = fileSystemId;
return DeleteFileSystemAsync(request, cancellationToken);
}
///
/// Deletes a file system, permanently severing access to its contents. Upon return, the
/// file system no longer exists and you can't access any contents of the deleted file
/// system.
///
///
///
/// You need to manually delete mount targets attached to a file system before you can
/// delete an EFS file system. This step is performed for you when you use the Amazon
/// Web Services console to delete a file system.
///
///
///
/// You cannot delete a file system that is part of an EFS Replication configuration.
/// You need to delete the replication configuration first.
///
///
///
/// You can't delete a file system that is in use. That is, if the file system has any
/// mount targets, you must first delete them. For more information, see DescribeMountTargets
/// and DeleteMountTarget.
///
///
///
/// The DeleteFileSystem call returns while the file system state is still
/// deleting. You can check the file system deletion status by calling the
/// DescribeFileSystems operation, which returns a list of file systems in your
/// account. If you pass file system ID or creation token for the deleted file system,
/// the DescribeFileSystems returns a 404 FileSystemNotFound error.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteFileSystem
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteFileSystem service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if a file system has mount targets.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteFileSystem Operation
public virtual Task DeleteFileSystemAsync(DeleteFileSystemRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteFileSystemRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteFileSystemResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteFileSystemPolicy
///
/// Deletes the FileSystemPolicy for the specified file system. The default
/// FileSystemPolicy goes into effect once the existing policy is deleted.
/// For more information about the default file system policy, see Using
/// Resource-based Policies with EFS.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteFileSystemPolicy service method.
///
/// The response from the DeleteFileSystemPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteFileSystemPolicy Operation
public virtual DeleteFileSystemPolicyResponse DeleteFileSystemPolicy(DeleteFileSystemPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteFileSystemPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteFileSystemPolicyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the FileSystemPolicy for the specified file system. The default
/// FileSystemPolicy goes into effect once the existing policy is deleted.
/// For more information about the default file system policy, see Using
/// Resource-based Policies with EFS.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteFileSystemPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteFileSystemPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteFileSystemPolicy Operation
public virtual Task DeleteFileSystemPolicyAsync(DeleteFileSystemPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteFileSystemPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteFileSystemPolicyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteMountTarget
///
/// Deletes the specified mount target.
///
///
///
/// This operation forcibly breaks any mounts of the file system by using the mount target
/// that is being deleted, which might disrupt instances or applications using those mounts.
/// To avoid applications getting cut off abruptly, you might consider unmounting any
/// mounts of the mount target, if feasible. The operation also deletes the associated
/// network interface. Uncommitted writes might be lost, but breaking a mount target using
/// this operation does not corrupt the file system itself. The file system you created
/// remains. You can mount an EC2 instance in your VPC by using another mount target.
///
///
///
/// This operation requires permissions for the following action on the file system:
///
/// -
///
///
elasticfilesystem:DeleteMountTarget
///
///
///
/// The DeleteMountTarget call returns while the mount target state is still
/// deleting. You can check the mount target deletion by calling the DescribeMountTargets
/// operation, which returns a list of mount target descriptions for the given file system.
///
///
///
///
/// The operation also requires permissions for the following Amazon EC2 action on the
/// mount target's network interface:
///
/// -
///
///
ec2:DeleteNetworkInterface
///
///
///
/// The ID of the mount target to delete (String).
///
/// The response from the DeleteMountTarget service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// The service timed out trying to fulfill the request, and the client should try the
/// call again.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DeleteMountTarget Operation
public virtual DeleteMountTargetResponse DeleteMountTarget(string mountTargetId)
{
var request = new DeleteMountTargetRequest();
request.MountTargetId = mountTargetId;
return DeleteMountTarget(request);
}
///
/// Deletes the specified mount target.
///
///
///
/// This operation forcibly breaks any mounts of the file system by using the mount target
/// that is being deleted, which might disrupt instances or applications using those mounts.
/// To avoid applications getting cut off abruptly, you might consider unmounting any
/// mounts of the mount target, if feasible. The operation also deletes the associated
/// network interface. Uncommitted writes might be lost, but breaking a mount target using
/// this operation does not corrupt the file system itself. The file system you created
/// remains. You can mount an EC2 instance in your VPC by using another mount target.
///
///
///
/// This operation requires permissions for the following action on the file system:
///
/// -
///
///
elasticfilesystem:DeleteMountTarget
///
///
///
/// The DeleteMountTarget call returns while the mount target state is still
/// deleting. You can check the mount target deletion by calling the DescribeMountTargets
/// operation, which returns a list of mount target descriptions for the given file system.
///
///
///
///
/// The operation also requires permissions for the following Amazon EC2 action on the
/// mount target's network interface:
///
/// -
///
///
ec2:DeleteNetworkInterface
///
///
///
/// Container for the necessary parameters to execute the DeleteMountTarget service method.
///
/// The response from the DeleteMountTarget service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// The service timed out trying to fulfill the request, and the client should try the
/// call again.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DeleteMountTarget Operation
public virtual DeleteMountTargetResponse DeleteMountTarget(DeleteMountTargetRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteMountTargetRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteMountTargetResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the specified mount target.
///
///
///
/// This operation forcibly breaks any mounts of the file system by using the mount target
/// that is being deleted, which might disrupt instances or applications using those mounts.
/// To avoid applications getting cut off abruptly, you might consider unmounting any
/// mounts of the mount target, if feasible. The operation also deletes the associated
/// network interface. Uncommitted writes might be lost, but breaking a mount target using
/// this operation does not corrupt the file system itself. The file system you created
/// remains. You can mount an EC2 instance in your VPC by using another mount target.
///
///
///
/// This operation requires permissions for the following action on the file system:
///
/// -
///
///
elasticfilesystem:DeleteMountTarget
///
///
///
/// The DeleteMountTarget call returns while the mount target state is still
/// deleting. You can check the mount target deletion by calling the DescribeMountTargets
/// operation, which returns a list of mount target descriptions for the given file system.
///
///
///
///
/// The operation also requires permissions for the following Amazon EC2 action on the
/// mount target's network interface:
///
/// -
///
///
ec2:DeleteNetworkInterface
///
///
///
/// The ID of the mount target to delete (String).
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteMountTarget service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// The service timed out trying to fulfill the request, and the client should try the
/// call again.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DeleteMountTarget Operation
public virtual Task DeleteMountTargetAsync(string mountTargetId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteMountTargetRequest();
request.MountTargetId = mountTargetId;
return DeleteMountTargetAsync(request, cancellationToken);
}
///
/// Deletes the specified mount target.
///
///
///
/// This operation forcibly breaks any mounts of the file system by using the mount target
/// that is being deleted, which might disrupt instances or applications using those mounts.
/// To avoid applications getting cut off abruptly, you might consider unmounting any
/// mounts of the mount target, if feasible. The operation also deletes the associated
/// network interface. Uncommitted writes might be lost, but breaking a mount target using
/// this operation does not corrupt the file system itself. The file system you created
/// remains. You can mount an EC2 instance in your VPC by using another mount target.
///
///
///
/// This operation requires permissions for the following action on the file system:
///
/// -
///
///
elasticfilesystem:DeleteMountTarget
///
///
///
/// The DeleteMountTarget call returns while the mount target state is still
/// deleting. You can check the mount target deletion by calling the DescribeMountTargets
/// operation, which returns a list of mount target descriptions for the given file system.
///
///
///
///
/// The operation also requires permissions for the following Amazon EC2 action on the
/// mount target's network interface:
///
/// -
///
///
ec2:DeleteNetworkInterface
///
///
///
/// Container for the necessary parameters to execute the DeleteMountTarget service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteMountTarget service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// The service timed out trying to fulfill the request, and the client should try the
/// call again.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DeleteMountTarget Operation
public virtual Task DeleteMountTargetAsync(DeleteMountTargetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteMountTargetRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteMountTargetResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteReplicationConfiguration
///
/// Deletes an existing replication configuration. To delete a replication configuration,
/// you must make the request from the Amazon Web Services Region in which the destination
/// file system is located. Deleting a replication configuration ends the replication
/// process. After a replication configuration is deleted, the destination file system
/// is no longer read-only. You can write to the destination file system after its status
/// becomes Writeable.
///
/// Container for the necessary parameters to execute the DeleteReplicationConfiguration service method.
///
/// The response from the DeleteReplicationConfiguration service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the specified file system does not have a replication configuration.
///
/// REST API Reference for DeleteReplicationConfiguration Operation
public virtual DeleteReplicationConfigurationResponse DeleteReplicationConfiguration(DeleteReplicationConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteReplicationConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteReplicationConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes an existing replication configuration. To delete a replication configuration,
/// you must make the request from the Amazon Web Services Region in which the destination
/// file system is located. Deleting a replication configuration ends the replication
/// process. After a replication configuration is deleted, the destination file system
/// is no longer read-only. You can write to the destination file system after its status
/// becomes Writeable.
///
/// Container for the necessary parameters to execute the DeleteReplicationConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteReplicationConfiguration service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the specified file system does not have a replication configuration.
///
/// REST API Reference for DeleteReplicationConfiguration Operation
public virtual Task DeleteReplicationConfigurationAsync(DeleteReplicationConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteReplicationConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteReplicationConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteTags
///
///
///
/// DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags
/// from EFS resources, use the API action.
///
///
///
/// Deletes the specified tags from a file system. If the DeleteTags request
/// includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an
/// error. For more information about tags and related restrictions, see Tag
/// restrictions in the Billing and Cost Management User Guide.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteTags
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteTags service method.
///
/// The response from the DeleteTags service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteTags Operation
[Obsolete("Use UntagResource.")]
public virtual DeleteTagsResponse DeleteTags(DeleteTagsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteTagsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
///
///
/// DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags
/// from EFS resources, use the API action.
///
///
///
/// Deletes the specified tags from a file system. If the DeleteTags request
/// includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an
/// error. For more information about tags and related restrictions, see Tag
/// restrictions in the Billing and Cost Management User Guide.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DeleteTags
/// action.
///
///
/// Container for the necessary parameters to execute the DeleteTags service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteTags service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DeleteTags Operation
[Obsolete("Use UntagResource.")]
public virtual Task DeleteTagsAsync(DeleteTagsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteTagsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeAccessPoints
///
/// Returns the description of a specific Amazon EFS access point if the AccessPointId
/// is provided. If you provide an EFS FileSystemId, it returns descriptions
/// of all access points for that file system. You can provide either an AccessPointId
/// or a FileSystemId in the request, but not both.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
/// action.
///
///
/// Container for the necessary parameters to execute the DescribeAccessPoints service method.
///
/// The response from the DescribeAccessPoints service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeAccessPoints Operation
public virtual DescribeAccessPointsResponse DescribeAccessPoints(DescribeAccessPointsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAccessPointsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAccessPointsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the description of a specific Amazon EFS access point if the AccessPointId
/// is provided. If you provide an EFS FileSystemId, it returns descriptions
/// of all access points for that file system. You can provide either an AccessPointId
/// or a FileSystemId in the request, but not both.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
/// action.
///
///
/// Container for the necessary parameters to execute the DescribeAccessPoints service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAccessPoints service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeAccessPoints Operation
public virtual Task DescribeAccessPointsAsync(DescribeAccessPointsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAccessPointsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAccessPointsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeAccountPreferences
///
/// 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. For more
/// information, see Managing Amazon
/// EFS resource IDs.
///
/// Container for the necessary parameters to execute the DescribeAccountPreferences service method.
///
/// The response from the DescribeAccountPreferences service method, as returned by ElasticFileSystem.
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeAccountPreferences Operation
public virtual DescribeAccountPreferencesResponse DescribeAccountPreferences(DescribeAccountPreferencesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAccountPreferencesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAccountPreferencesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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. For more
/// information, see Managing Amazon
/// EFS resource IDs.
///
/// Container for the necessary parameters to execute the DescribeAccountPreferences service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAccountPreferences service method, as returned by ElasticFileSystem.
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeAccountPreferences Operation
public virtual Task DescribeAccountPreferencesAsync(DescribeAccountPreferencesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeAccountPreferencesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeAccountPreferencesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeBackupPolicy
///
/// Returns the backup policy for the specified EFS file system.
///
/// Container for the necessary parameters to execute the DescribeBackupPolicy service method.
///
/// The response from the DescribeBackupPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the default file system policy is in effect for the EFS file system specified.
///
///
/// Returned if the Backup service is not available in the Amazon Web Services Region
/// in which the request was made.
///
/// REST API Reference for DescribeBackupPolicy Operation
public virtual DescribeBackupPolicyResponse DescribeBackupPolicy(DescribeBackupPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeBackupPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeBackupPolicyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the backup policy for the specified EFS file system.
///
/// Container for the necessary parameters to execute the DescribeBackupPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeBackupPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the default file system policy is in effect for the EFS file system specified.
///
///
/// Returned if the Backup service is not available in the Amazon Web Services Region
/// in which the request was made.
///
/// REST API Reference for DescribeBackupPolicy Operation
public virtual Task DescribeBackupPolicyAsync(DescribeBackupPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeBackupPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeBackupPolicyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeFileSystemPolicy
///
/// Returns the FileSystemPolicy for the specified EFS file system.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy
/// action.
///
///
/// Container for the necessary parameters to execute the DescribeFileSystemPolicy service method.
///
/// The response from the DescribeFileSystemPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the default file system policy is in effect for the EFS file system specified.
///
/// REST API Reference for DescribeFileSystemPolicy Operation
public virtual DescribeFileSystemPolicyResponse DescribeFileSystemPolicy(DescribeFileSystemPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeFileSystemPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeFileSystemPolicyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the FileSystemPolicy for the specified EFS file system.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy
/// action.
///
///
/// Container for the necessary parameters to execute the DescribeFileSystemPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeFileSystemPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the default file system policy is in effect for the EFS file system specified.
///
/// REST API Reference for DescribeFileSystemPolicy Operation
public virtual Task DescribeFileSystemPolicyAsync(DescribeFileSystemPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeFileSystemPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeFileSystemPolicyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeFileSystems
///
/// Returns the description of a specific Amazon EFS file system if either the file system
/// CreationToken or the FileSystemId is provided. Otherwise,
/// it returns descriptions of all file systems owned by the caller's Amazon Web Services
/// account in the Amazon Web Services Region of the endpoint that you're calling.
///
///
///
/// When retrieving all file system descriptions, you can optionally specify the MaxItems
/// parameter to limit the number of descriptions in a response. This number is automatically
/// set to 100. If more file system descriptions remain, Amazon EFS returns a NextMarker,
/// an opaque token, in the response. In this case, you should send a subsequent request
/// with the Marker request parameter set to the value of NextMarker.
///
///
///
///
/// To retrieve a list of your file system descriptions, this operation is used in an
/// iterative process, where DescribeFileSystems is called first without
/// the Marker and then the operation continues to call it with the Marker
/// parameter set to the value of the NextMarker from the previous response
/// until the response has no NextMarker.
///
///
///
/// The order of file systems returned in the response of one DescribeFileSystems
/// call and the order of file systems returned across the responses of a multi-call iteration
/// is unspecified.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeFileSystems
/// action.
///
///
/// Container for the necessary parameters to execute the DescribeFileSystems service method.
///
/// The response from the DescribeFileSystems service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeFileSystems Operation
public virtual DescribeFileSystemsResponse DescribeFileSystems(DescribeFileSystemsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeFileSystemsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeFileSystemsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the description of a specific Amazon EFS file system if either the file system
/// CreationToken or the FileSystemId is provided. Otherwise,
/// it returns descriptions of all file systems owned by the caller's Amazon Web Services
/// account in the Amazon Web Services Region of the endpoint that you're calling.
///
///
///
/// When retrieving all file system descriptions, you can optionally specify the MaxItems
/// parameter to limit the number of descriptions in a response. This number is automatically
/// set to 100. If more file system descriptions remain, Amazon EFS returns a NextMarker,
/// an opaque token, in the response. In this case, you should send a subsequent request
/// with the Marker request parameter set to the value of NextMarker.
///
///
///
///
/// To retrieve a list of your file system descriptions, this operation is used in an
/// iterative process, where DescribeFileSystems is called first without
/// the Marker and then the operation continues to call it with the Marker
/// parameter set to the value of the NextMarker from the previous response
/// until the response has no NextMarker.
///
///
///
/// The order of file systems returned in the response of one DescribeFileSystems
/// call and the order of file systems returned across the responses of a multi-call iteration
/// is unspecified.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeFileSystems
/// action.
///
///
/// Container for the necessary parameters to execute the DescribeFileSystems service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeFileSystems service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeFileSystems Operation
public virtual Task DescribeFileSystemsAsync(DescribeFileSystemsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeFileSystemsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeFileSystemsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeLifecycleConfiguration
///
/// Returns the current LifecycleConfiguration object for the specified Amazon
/// EFS file system. EFS lifecycle management uses the LifecycleConfiguration
/// object to identify which files to move to the EFS Infrequent Access (IA) storage class.
/// For a file system without a LifecycleConfiguration object, the call returns
/// an empty array in the response.
///
///
///
/// When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass
/// has a value of AFTER_1_ACCESS.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration
/// operation.
///
///
/// Container for the necessary parameters to execute the DescribeLifecycleConfiguration service method.
///
/// The response from the DescribeLifecycleConfiguration service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeLifecycleConfiguration Operation
public virtual DescribeLifecycleConfigurationResponse DescribeLifecycleConfiguration(DescribeLifecycleConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeLifecycleConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the current LifecycleConfiguration object for the specified Amazon
/// EFS file system. EFS lifecycle management uses the LifecycleConfiguration
/// object to identify which files to move to the EFS Infrequent Access (IA) storage class.
/// For a file system without a LifecycleConfiguration object, the call returns
/// an empty array in the response.
///
///
///
/// When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass
/// has a value of AFTER_1_ACCESS.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration
/// operation.
///
///
/// Container for the necessary parameters to execute the DescribeLifecycleConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeLifecycleConfiguration service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeLifecycleConfiguration Operation
public virtual Task DescribeLifecycleConfigurationAsync(DescribeLifecycleConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeLifecycleConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeMountTargets
///
/// Returns the descriptions of all the current mount targets, or a specific mount target,
/// for a file system. When requesting all of the current mount targets, the order of
/// mount targets returned in the response is unspecified.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeMountTargets
/// action, on either the file system ID that you specify in FileSystemId,
/// or on the file system of the mount target that you specify in MountTargetId.
///
///
/// (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.
///
/// The response from the DescribeMountTargets service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DescribeMountTargets Operation
public virtual DescribeMountTargetsResponse DescribeMountTargets(string fileSystemId)
{
var request = new DescribeMountTargetsRequest();
request.FileSystemId = fileSystemId;
return DescribeMountTargets(request);
}
///
/// Returns the descriptions of all the current mount targets, or a specific mount target,
/// for a file system. When requesting all of the current mount targets, the order of
/// mount targets returned in the response is unspecified.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeMountTargets
/// action, on either the file system ID that you specify in FileSystemId,
/// or on the file system of the mount target that you specify in MountTargetId.
///
///
/// Container for the necessary parameters to execute the DescribeMountTargets service method.
///
/// The response from the DescribeMountTargets service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DescribeMountTargets Operation
public virtual DescribeMountTargetsResponse DescribeMountTargets(DescribeMountTargetsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeMountTargetsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeMountTargetsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the descriptions of all the current mount targets, or a specific mount target,
/// for a file system. When requesting all of the current mount targets, the order of
/// mount targets returned in the response is unspecified.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeMountTargets
/// action, on either the file system ID that you specify in FileSystemId,
/// or on the file system of the mount target that you specify in MountTargetId.
///
///
/// (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeMountTargets service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DescribeMountTargets Operation
public virtual Task DescribeMountTargetsAsync(string fileSystemId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DescribeMountTargetsRequest();
request.FileSystemId = fileSystemId;
return DescribeMountTargetsAsync(request, cancellationToken);
}
///
/// Returns the descriptions of all the current mount targets, or a specific mount target,
/// for a file system. When requesting all of the current mount targets, the order of
/// mount targets returned in the response is unspecified.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeMountTargets
/// action, on either the file system ID that you specify in FileSystemId,
/// or on the file system of the mount target that you specify in MountTargetId.
///
///
/// Container for the necessary parameters to execute the DescribeMountTargets service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeMountTargets service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DescribeMountTargets Operation
public virtual Task DescribeMountTargetsAsync(DescribeMountTargetsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeMountTargetsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeMountTargetsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeMountTargetSecurityGroups
///
/// Returns the security groups currently in effect for a mount target. This operation
/// requires that the network interface of the mount target has been created and the lifecycle
/// state of the mount target is not deleted.
///
///
///
/// This operation requires permissions for the following actions:
///
/// -
///
///
elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount
/// target's file system.
///
/// -
///
///
ec2:DescribeNetworkInterfaceAttribute action on the mount target's network
/// interface.
///
///
///
/// The ID of the mount target whose security groups you want to retrieve.
///
/// The response from the DescribeMountTargetSecurityGroups service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the mount target is not in the correct state for the operation.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DescribeMountTargetSecurityGroups Operation
public virtual DescribeMountTargetSecurityGroupsResponse DescribeMountTargetSecurityGroups(string mountTargetId)
{
var request = new DescribeMountTargetSecurityGroupsRequest();
request.MountTargetId = mountTargetId;
return DescribeMountTargetSecurityGroups(request);
}
///
/// Returns the security groups currently in effect for a mount target. This operation
/// requires that the network interface of the mount target has been created and the lifecycle
/// state of the mount target is not deleted.
///
///
///
/// This operation requires permissions for the following actions:
///
/// -
///
///
elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount
/// target's file system.
///
/// -
///
///
ec2:DescribeNetworkInterfaceAttribute action on the mount target's network
/// interface.
///
///
///
/// Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups service method.
///
/// The response from the DescribeMountTargetSecurityGroups service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the mount target is not in the correct state for the operation.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DescribeMountTargetSecurityGroups Operation
public virtual DescribeMountTargetSecurityGroupsResponse DescribeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeMountTargetSecurityGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeMountTargetSecurityGroupsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the security groups currently in effect for a mount target. This operation
/// requires that the network interface of the mount target has been created and the lifecycle
/// state of the mount target is not deleted.
///
///
///
/// This operation requires permissions for the following actions:
///
/// -
///
///
elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount
/// target's file system.
///
/// -
///
///
ec2:DescribeNetworkInterfaceAttribute action on the mount target's network
/// interface.
///
///
///
/// The ID of the mount target whose security groups you want to retrieve.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeMountTargetSecurityGroups service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the mount target is not in the correct state for the operation.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DescribeMountTargetSecurityGroups Operation
public virtual Task DescribeMountTargetSecurityGroupsAsync(string mountTargetId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DescribeMountTargetSecurityGroupsRequest();
request.MountTargetId = mountTargetId;
return DescribeMountTargetSecurityGroupsAsync(request, cancellationToken);
}
///
/// Returns the security groups currently in effect for a mount target. This operation
/// requires that the network interface of the mount target has been created and the lifecycle
/// state of the mount target is not deleted.
///
///
///
/// This operation requires permissions for the following actions:
///
/// -
///
///
elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount
/// target's file system.
///
/// -
///
///
ec2:DescribeNetworkInterfaceAttribute action on the mount target's network
/// interface.
///
///
///
/// Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeMountTargetSecurityGroups service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the mount target is not in the correct state for the operation.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
/// REST API Reference for DescribeMountTargetSecurityGroups Operation
public virtual Task DescribeMountTargetSecurityGroupsAsync(DescribeMountTargetSecurityGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeMountTargetSecurityGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeMountTargetSecurityGroupsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeReplicationConfigurations
///
/// 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.
///
/// Container for the necessary parameters to execute the DescribeReplicationConfigurations service method.
///
/// The response from the DescribeReplicationConfigurations service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the specified file system does not have a replication configuration.
///
///
/// Returned if the Backup service is not available in the Amazon Web Services Region
/// in which the request was made.
///
/// REST API Reference for DescribeReplicationConfigurations Operation
public virtual DescribeReplicationConfigurationsResponse DescribeReplicationConfigurations(DescribeReplicationConfigurationsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeReplicationConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeReplicationConfigurationsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
/// Container for the necessary parameters to execute the DescribeReplicationConfigurations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeReplicationConfigurations service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the specified file system does not have a replication configuration.
///
///
/// Returned if the Backup service is not available in the Amazon Web Services Region
/// in which the request was made.
///
/// REST API Reference for DescribeReplicationConfigurations Operation
public virtual Task DescribeReplicationConfigurationsAsync(DescribeReplicationConfigurationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeReplicationConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeReplicationConfigurationsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeTags
///
///
///
/// DEPRECATED - The DescribeTags action is deprecated and not maintained.
/// To view tags associated with EFS resources, use the ListTagsForResource
/// API action.
///
///
///
/// Returns the tags associated with a file system. The order of tags returned in the
/// response of one DescribeTags call and the order of tags returned across
/// the responses of a multiple-call iteration (when using pagination) is unspecified.
///
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeTags
/// action.
///
///
/// The ID of the file system whose tag set you want to retrieve.
///
/// The response from the DescribeTags service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeTags Operation
[Obsolete("Use ListTagsForResource.")]
public virtual DescribeTagsResponse DescribeTags(string fileSystemId)
{
var request = new DescribeTagsRequest();
request.FileSystemId = fileSystemId;
return DescribeTags(request);
}
///
///
///
/// DEPRECATED - The DescribeTags action is deprecated and not maintained.
/// To view tags associated with EFS resources, use the ListTagsForResource
/// API action.
///
///
///
/// Returns the tags associated with a file system. The order of tags returned in the
/// response of one DescribeTags call and the order of tags returned across
/// the responses of a multiple-call iteration (when using pagination) is unspecified.
///
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeTags
/// action.
///
///
/// Container for the necessary parameters to execute the DescribeTags service method.
///
/// The response from the DescribeTags service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeTags Operation
[Obsolete("Use ListTagsForResource.")]
public virtual DescribeTagsResponse DescribeTags(DescribeTagsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeTagsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
///
///
/// DEPRECATED - The DescribeTags action is deprecated and not maintained.
/// To view tags associated with EFS resources, use the ListTagsForResource
/// API action.
///
///
///
/// Returns the tags associated with a file system. The order of tags returned in the
/// response of one DescribeTags call and the order of tags returned across
/// the responses of a multiple-call iteration (when using pagination) is unspecified.
///
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeTags
/// action.
///
///
/// The ID of the file system whose tag set you want to retrieve.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeTags service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeTags Operation
[Obsolete("Use ListTagsForResource.")]
public virtual Task DescribeTagsAsync(string fileSystemId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DescribeTagsRequest();
request.FileSystemId = fileSystemId;
return DescribeTagsAsync(request, cancellationToken);
}
///
///
///
/// DEPRECATED - The DescribeTags action is deprecated and not maintained.
/// To view tags associated with EFS resources, use the ListTagsForResource
/// API action.
///
///
///
/// Returns the tags associated with a file system. The order of tags returned in the
/// response of one DescribeTags call and the order of tags returned across
/// the responses of a multiple-call iteration (when using pagination) is unspecified.
///
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeTags
/// action.
///
///
/// Container for the necessary parameters to execute the DescribeTags service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeTags service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for DescribeTags Operation
[Obsolete("Use ListTagsForResource.")]
public virtual Task DescribeTagsAsync(DescribeTagsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeTagsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListTagsForResource
///
/// Lists all tags for a top-level EFS resource. You must provide the ID of the resource
/// that you want to retrieve the tags for.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
/// action.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for ListTagsForResource Operation
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists all tags for a top-level EFS resource. You must provide the ID of the resource
/// that you want to retrieve the tags for.
///
///
///
/// This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
/// action.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for ListTagsForResource Operation
public virtual Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ModifyMountTargetSecurityGroups
///
/// Modifies the set of security groups in effect for a mount target.
///
///
///
/// When you create a mount target, Amazon EFS also creates a new network interface. For
/// more information, see CreateMountTarget. This operation replaces the security
/// groups in effect for the network interface associated with a mount target, with the
/// SecurityGroups provided in the request. This operation requires that
/// the network interface of the mount target has been created and the lifecycle state
/// of the mount target is not deleted.
///
///
///
/// The operation requires permissions for the following actions:
///
/// -
///
///
elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount
/// target's file system.
///
/// -
///
///
ec2:ModifyNetworkInterfaceAttribute action on the mount target's network
/// interface.
///
///
///
/// Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups service method.
///
/// The response from the ModifyMountTargetSecurityGroups service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the mount target is not in the correct state for the operation.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
///
/// Returned if the size of SecurityGroups specified in the request is greater
/// than five.
///
///
/// Returned if one of the specified security groups doesn't exist in the subnet's virtual
/// private cloud (VPC).
///
/// REST API Reference for ModifyMountTargetSecurityGroups Operation
public virtual ModifyMountTargetSecurityGroupsResponse ModifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyMountTargetSecurityGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyMountTargetSecurityGroupsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Modifies the set of security groups in effect for a mount target.
///
///
///
/// When you create a mount target, Amazon EFS also creates a new network interface. For
/// more information, see CreateMountTarget. This operation replaces the security
/// groups in effect for the network interface associated with a mount target, with the
/// SecurityGroups provided in the request. This operation requires that
/// the network interface of the mount target has been created and the lifecycle state
/// of the mount target is not deleted.
///
///
///
/// The operation requires permissions for the following actions:
///
/// -
///
///
elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount
/// target's file system.
///
/// -
///
///
ec2:ModifyNetworkInterfaceAttribute action on the mount target's network
/// interface.
///
///
///
/// Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyMountTargetSecurityGroups service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the mount target is not in the correct state for the operation.
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if there is no mount target with the specified ID found in the caller's Amazon
/// Web Services account.
///
///
/// Returned if the size of SecurityGroups specified in the request is greater
/// than five.
///
///
/// Returned if one of the specified security groups doesn't exist in the subnet's virtual
/// private cloud (VPC).
///
/// REST API Reference for ModifyMountTargetSecurityGroups Operation
public virtual Task ModifyMountTargetSecurityGroupsAsync(ModifyMountTargetSecurityGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyMountTargetSecurityGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyMountTargetSecurityGroupsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutAccountPreferences
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the PutAccountPreferences service method.
///
/// The response from the PutAccountPreferences service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for PutAccountPreferences Operation
public virtual PutAccountPreferencesResponse PutAccountPreferences(PutAccountPreferencesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutAccountPreferencesRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutAccountPreferencesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the PutAccountPreferences service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutAccountPreferences service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for PutAccountPreferences Operation
public virtual Task PutAccountPreferencesAsync(PutAccountPreferencesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutAccountPreferencesRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutAccountPreferencesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutBackupPolicy
///
/// Updates the file system's backup policy. Use this action to start or stop automatic
/// backups of the file system.
///
/// Container for the necessary parameters to execute the PutBackupPolicy service method.
///
/// The response from the PutBackupPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the Backup service is not available in the Amazon Web Services Region
/// in which the request was made.
///
/// REST API Reference for PutBackupPolicy Operation
public virtual PutBackupPolicyResponse PutBackupPolicy(PutBackupPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBackupPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBackupPolicyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Updates the file system's backup policy. Use this action to start or stop automatic
/// backups of the file system.
///
/// Container for the necessary parameters to execute the PutBackupPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutBackupPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the Backup service is not available in the Amazon Web Services Region
/// in which the request was made.
///
/// REST API Reference for PutBackupPolicy Operation
public virtual Task PutBackupPolicyAsync(PutBackupPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBackupPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBackupPolicyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutFileSystemPolicy
///
/// Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system.
/// A file system policy is an IAM resource-based policy and can contain multiple policy
/// statements. A file system always has exactly one file system policy, which can be
/// the default policy or an explicit policy set or updated using this API operation.
/// EFS file system policies have a 20,000 character limit. When an explicit policy is
/// set, it overrides the default policy. For more information about the default file
/// system policy, see Default
/// EFS File System Policy.
///
///
///
/// EFS file system policies have a 20,000 character limit.
///
///
///
/// This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy
/// action.
///
///
/// Container for the necessary parameters to execute the PutFileSystemPolicy service method.
///
/// The response from the PutFileSystemPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the FileSystemPolicy is malformed or contains an error such
/// as a parameter value that is not valid or a missing required parameter. Returned in
/// the case of a policy lockout safety check error.
///
/// REST API Reference for PutFileSystemPolicy Operation
public virtual PutFileSystemPolicyResponse PutFileSystemPolicy(PutFileSystemPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutFileSystemPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutFileSystemPolicyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system.
/// A file system policy is an IAM resource-based policy and can contain multiple policy
/// statements. A file system always has exactly one file system policy, which can be
/// the default policy or an explicit policy set or updated using this API operation.
/// EFS file system policies have a 20,000 character limit. When an explicit policy is
/// set, it overrides the default policy. For more information about the default file
/// system policy, see Default
/// EFS File System Policy.
///
///
///
/// EFS file system policies have a 20,000 character limit.
///
///
///
/// This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy
/// action.
///
///
/// Container for the necessary parameters to execute the PutFileSystemPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutFileSystemPolicy service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
///
/// Returned if the FileSystemPolicy is malformed or contains an error such
/// as a parameter value that is not valid or a missing required parameter. Returned in
/// the case of a policy lockout safety check error.
///
/// REST API Reference for PutFileSystemPolicy Operation
public virtual Task PutFileSystemPolicyAsync(PutFileSystemPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutFileSystemPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutFileSystemPolicyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutLifecycleConfiguration
///
/// Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A
/// LifecycleConfiguration consists of one or more LifecyclePolicy
/// objects that define the following:
///
/// -
///
/// EFS Lifecycle management - When Amazon EFS automatically transitions files
/// in a file system into the lower-cost EFS Infrequent Access (IA) storage class.
///
///
///
/// To enable EFS Lifecycle management, set the value of
TransitionToIA to
/// one of the available options.
///
/// -
///
/// EFS Intelligent-Tiering - When Amazon EFS automatically transitions files
/// from IA back into the file system's primary storage class (EFS Standard or EFS One
/// Zone Standard).
///
///
///
/// To enable EFS Intelligent-Tiering, set the value of
TransitionToPrimaryStorageClass
/// to AFTER_1_ACCESS.
///
///
///
/// For more information, see EFS
/// Lifecycle Management.
///
///
///
/// Each Amazon EFS file system supports one lifecycle configuration, which applies to
/// all files in the file system. If a LifecycleConfiguration object already
/// exists for the specified file system, a PutLifecycleConfiguration call
/// modifies the existing configuration. A PutLifecycleConfiguration call
/// with an empty LifecyclePolicies array in the request body deletes any
/// existing LifecycleConfiguration and turns off lifecycle management and
/// EFS Intelligent-Tiering for the file system.
///
///
///
/// In the request, specify the following:
///
/// -
///
/// The ID for the file system for which you are enabling, disabling, or modifying lifecycle
/// management and EFS Intelligent-Tiering.
///
///
-
///
/// A
LifecyclePolicies array of LifecyclePolicy objects that
/// define when files are moved into IA storage, and when they are moved back to Standard
/// storage.
///
///
///
/// Amazon EFS requires that each LifecyclePolicy object have only have a
/// single transition, so the LifecyclePolicies array needs to be structured
/// with separate LifecyclePolicy objects. See the example requests in the
/// following section for more information.
///
///
///
/// This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration
/// operation.
///
///
///
/// To apply a LifecycleConfiguration object to an encrypted file system,
/// you need the same Key Management Service permissions as when you created the encrypted
/// file system.
///
///
/// Container for the necessary parameters to execute the PutLifecycleConfiguration service method.
///
/// The response from the PutLifecycleConfiguration service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for PutLifecycleConfiguration Operation
public virtual PutLifecycleConfigurationResponse PutLifecycleConfiguration(PutLifecycleConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutLifecycleConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A
/// LifecycleConfiguration consists of one or more LifecyclePolicy
/// objects that define the following:
///
/// -
///
/// EFS Lifecycle management - When Amazon EFS automatically transitions files
/// in a file system into the lower-cost EFS Infrequent Access (IA) storage class.
///
///
///
/// To enable EFS Lifecycle management, set the value of
TransitionToIA to
/// one of the available options.
///
/// -
///
/// EFS Intelligent-Tiering - When Amazon EFS automatically transitions files
/// from IA back into the file system's primary storage class (EFS Standard or EFS One
/// Zone Standard).
///
///
///
/// To enable EFS Intelligent-Tiering, set the value of
TransitionToPrimaryStorageClass
/// to AFTER_1_ACCESS.
///
///
///
/// For more information, see EFS
/// Lifecycle Management.
///
///
///
/// Each Amazon EFS file system supports one lifecycle configuration, which applies to
/// all files in the file system. If a LifecycleConfiguration object already
/// exists for the specified file system, a PutLifecycleConfiguration call
/// modifies the existing configuration. A PutLifecycleConfiguration call
/// with an empty LifecyclePolicies array in the request body deletes any
/// existing LifecycleConfiguration and turns off lifecycle management and
/// EFS Intelligent-Tiering for the file system.
///
///
///
/// In the request, specify the following:
///
/// -
///
/// The ID for the file system for which you are enabling, disabling, or modifying lifecycle
/// management and EFS Intelligent-Tiering.
///
///
-
///
/// A
LifecyclePolicies array of LifecyclePolicy objects that
/// define when files are moved into IA storage, and when they are moved back to Standard
/// storage.
///
///
///
/// Amazon EFS requires that each LifecyclePolicy object have only have a
/// single transition, so the LifecyclePolicies array needs to be structured
/// with separate LifecyclePolicy objects. See the example requests in the
/// following section for more information.
///
///
///
/// This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration
/// operation.
///
///
///
/// To apply a LifecycleConfiguration object to an encrypted file system,
/// you need the same Key Management Service permissions as when you created the encrypted
/// file system.
///
///
/// Container for the necessary parameters to execute the PutLifecycleConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutLifecycleConfiguration service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for PutLifecycleConfiguration Operation
public virtual Task PutLifecycleConfigurationAsync(PutLifecycleConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutLifecycleConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region TagResource
///
/// Creates a tag for an EFS resource. You can create tags for EFS file systems and access
/// points using this API operation.
///
///
///
/// This operation requires permissions for the elasticfilesystem:TagResource
/// action.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for TagResource Operation
public virtual TagResourceResponse TagResource(TagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a tag for an EFS resource. You can create tags for EFS file systems and access
/// points using this API operation.
///
///
///
/// This operation requires permissions for the elasticfilesystem:TagResource
/// action.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for TagResource Operation
public virtual Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UntagResource
///
/// Removes tags from an EFS resource. You can remove tags from EFS file systems and access
/// points using this API operation.
///
///
///
/// This operation requires permissions for the elasticfilesystem:UntagResource
/// action.
///
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for UntagResource Operation
public virtual UntagResourceResponse UntagResource(UntagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes tags from an EFS resource. You can remove tags from EFS file systems and access
/// points using this API operation.
///
///
///
/// This operation requires permissions for the elasticfilesystem:UntagResource
/// action.
///
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by ElasticFileSystem.
///
/// Returned if the specified AccessPointId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if an error occurred on the server side.
///
/// REST API Reference for UntagResource Operation
public virtual Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region UpdateFileSystem
///
/// Updates the throughput mode or the amount of provisioned throughput of an existing
/// file system.
///
/// Container for the necessary parameters to execute the UpdateFileSystem service method.
///
/// The response from the UpdateFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// 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.
///
///
/// Returned if an error occurred on the server side.
///
///
/// 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.
///
///
/// Returned if you don’t wait at least 24 hours before either changing the throughput
/// mode, or decreasing the Provisioned Throughput value.
///
/// REST API Reference for UpdateFileSystem Operation
public virtual UpdateFileSystemResponse UpdateFileSystem(UpdateFileSystemRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateFileSystemRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateFileSystemResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Updates the throughput mode or the amount of provisioned throughput of an existing
/// file system.
///
/// Container for the necessary parameters to execute the UpdateFileSystem service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateFileSystem service method, as returned by ElasticFileSystem.
///
/// Returned if the request is malformed or contains an error such as an invalid parameter
/// value or a missing required parameter.
///
///
/// Returned if the specified FileSystemId value doesn't exist in the requester's
/// Amazon Web Services account.
///
///
/// Returned if the file system's lifecycle state is not "available".
///
///
/// 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.
///
///
/// Returned if an error occurred on the server side.
///
///
/// 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.
///
///
/// Returned if you don’t wait at least 24 hours before either changing the throughput
/// mode, or decreasing the Provisioned Throughput value.
///
/// REST API Reference for UpdateFileSystem Operation
public virtual Task UpdateFileSystemAsync(UpdateFileSystemRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateFileSystemRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateFileSystemResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
}
}