openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 152 kB

JSON

{"openapi":"3.0.0","info":{"version":"2015-02-01","x-release":"v4","title":"Amazon Elastic File System","description":"<fullname>Amazon Elastic File System</fullname> 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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/api-reference.html\">Amazon Elastic File System API Reference</a> and the <a href=\"https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html\">Amazon Elastic File System User Guide</a>.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"elasticfilesystem","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/elasticfilesystem-2015-02-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/elasticfilesystem/"},"servers":[{"url":"http://elasticfilesystem.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The EFS multi-region endpoint"},{"url":"https://elasticfilesystem.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The EFS multi-region endpoint"},{"url":"http://elasticfilesystem.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The EFS endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://elasticfilesystem.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The EFS endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/2015-02-01/access-points":{"post":{"operationId":"CreateAccessPoint","description":"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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html\">Mounting a file system using EFS access points</a>. <note> 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. </note> This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action. Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the <code>elasticfilesystem:TagResource</code> action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the <code>elasticfilesystem:TagResource</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html\">Granting permissions to tag resources during creation</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointDescription"}}}},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"AccessPointAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointAlreadyExists"}}}},"482":{"description":"IncorrectFileSystemLifeCycleState","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncorrectFileSystemLifeCycleState"}}}},"483":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}},"484":{"description":"FileSystemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemNotFound"}}}},"485":{"description":"AccessPointLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointLimitExceeded"}}}},"486":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ClientToken","FileSystemId"],"properties":{"ClientToken":{"description":"A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.","type":"string","pattern":".+","minLength":1,"maxLength":64},"Tags":{"description":"Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the Amazon Web Services General Reference Guide.","type":"array","items":{"$ref":"#/components/schemas/Tag"}},"FileSystemId":{"description":"The ID of the EFS file system that the access point provides access to.","type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$","maxLength":128},"PosixUser":{"description":"The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.","type":"object","properties":{"Uid":{"allOf":[{"$ref":"#/components/schemas/Uid"},{"description":"The POSIX user ID used for all file system operations using this access point."}]},"Gid":{"allOf":[{"$ref":"#/components/schemas/Gid"},{"description":"The POSIX group ID used for all file system operations using this access point."}]},"SecondaryGids":{"allOf":[{"$ref":"#/components/schemas/SecondaryGids"},{"description":"Secondary POSIX group IDs used for all file system operations using this access point."}]}}},"RootDirectory":{"description":"Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's <code>RootDirectory</code> and it's subdirectories.","type":"object","properties":{"Path":{"allOf":[{"$ref":"#/components/schemas/Path"},{"description":"Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the <code>CreationInfo</code>."}]},"CreationInfo":{"allOf":[{"$ref":"#/components/schemas/CreationInfo"},{"description":"(Optional) Specifies the POSIX IDs and permissions to apply to the access point's <code>RootDirectory</code>. If the <code>RootDirectory</code> > <code>Path</code> specified does not exist, EFS creates the root directory using the <code>CreationInfo</code> settings when a client connects to an access point. When specifying the <code>CreationInfo</code>, you must provide values for all properties. <important> If you do not provide <code>CreationInfo</code> and the specified <code>RootDirectory</code> > <code>Path</code> does not exist, attempts to mount the file system using the access point will fail. </important>"}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"DescribeAccessPoints","description":"Returns the description of a specific Amazon EFS access point if the <code>AccessPointId</code> is provided. If you provide an EFS <code>FileSystemId</code>, it returns descriptions of all access points for that file system. You can provide either an <code>AccessPointId</code> or a <code>FileSystemId</code> in the request, but not both. This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeAccessPointsResponse"}}}},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}},"482":{"description":"FileSystemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemNotFound"}}}},"483":{"description":"AccessPointNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointNotFound"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"(Optional) When retrieving all access points for a file system, you can optionally specify the <code>MaxItems</code> parameter to limit the number of objects returned in a response. The default value is 100. ","schema":{"type":"integer","description":"Max results used for pagination.","minimum":1}},{"name":"NextToken","in":"query","required":false,"description":" <code>NextToken</code> is present if the response is paginated. You can use <code>NextMarker</code> in the subsequent request to fetch the next page of access point descriptions.","schema":{"type":"string","pattern":".+","description":"Token used for pagination.","minLength":1,"maxLength":128}},{"name":"AccessPointId","in":"query","required":false,"description":"(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with <code>FileSystemId</code>.","schema":{"type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$","maxLength":128}},{"name":"FileSystemId","in":"query","required":false,"description":"(Optional) If you provide a <code>FileSystemId</code>, EFS returns all access points for that file system; mutually exclusive with <code>AccessPointId</code>.","schema":{"type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$","maxLength":128}}]}},"/2015-02-01/file-systems":{"post":{"operationId":"CreateFileSystem","description":"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: <ul> <li> Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state <code>creating</code>. </li> <li> Returns with the description of the created file system. </li> </ul> Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system. <note> For basic use cases, you can use a randomly generated UUID for the creation token. </note> The idempotent operation allows you to retry a <code>CreateFileSystem</code> 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 <code>FileSystemAlreadyExists</code> error. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1\">Creating a file system</a> in the Amazon EFS User Guide. <note> The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still <code>creating</code>. You can check the file system creation status by calling the <a>DescribeFileSystems</a> operation, which among other things returns the file system state. </note> This operation accepts an optional <code>PerformanceMode</code> parameter that you choose for your file system. We recommend <code>generalPurpose</code> performance mode for most file systems. File systems using the <code>maxIO</code> 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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html\">Amazon EFS performance modes</a>. You can set the throughput mode for the file system using the <code>ThroughputMode</code> parameter. After the file system is fully created, Amazon EFS sets its lifecycle state to <code>available</code>, at which point you can create one or more mount targets for the file system in your VPC. For more information, see <a>CreateMountTarget</a>. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. This operation requires permissions for the <code>elasticfilesystem:CreateFileSystem</code> action. File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the <code>elasticfilesystem:TagResource</code> action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the <code>elasticfilesystem:TagResource</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html\">Granting permissions to tag resources during creation</a>.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemDescription"}}}},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}},"482":{"description":"FileSystemAlreadyExists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemAlreadyExists"}}}},"483":{"description":"FileSystemLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemLimitExceeded"}}}},"484":{"description":"InsufficientThroughputCapacity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientThroughputCapacity"}}}},"485":{"description":"ThroughputLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThroughputLimitExceeded"}}}},"486":{"description":"UnsupportedAvailabilityZone","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedAvailabilityZone"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CreationToken"],"properties":{"CreationToken":{"description":"A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.","type":"string","pattern":".+","minLength":1,"maxLength":64},"PerformanceMode":{"description":"The performance mode of the file system. We recommend <code>generalPurpose</code> performance mode for most file systems. File systems using the <code>maxIO</code> 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. <note> The <code>maxIO</code> mode is not supported on file systems using One Zone storage classes. </note>","type":"string","enum":["generalPurpose","maxIO"]},"Encrypted":{"description":"A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying an existing Key Management Service key (KMS key). If you don't specify a KMS key, then the default KMS key for Amazon EFS, <code>/aws/elasticfilesystem</code>, is used to protect the encrypted file system. ","type":"boolean"},"KmsKeyId":{"description":"The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using the following formats: <ul> <li> Key ID - A unique identifier of the key, for example <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>. </li> <li> ARN - An Amazon Resource Name (ARN) for the key, for example <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>. </li> <li> Key alias - A previously created display name for a key, for example <code>alias/projectKey1</code>. </li> <li> Key alias ARN - An ARN for a key alias, for example <code>arn:aws:kms:us-west-2:444455556666:alias/projectKey1</code>. </li> </ul> If you use <code>KmsKeyId</code>, you must set the <a>CreateFileSystemRequest$Encrypted</a> parameter to true. <important> EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems. </important>","type":"string","pattern":"^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$","maxLength":2048},"ThroughputMode":{"description":"Specifies the throughput mode for the file system. The mode can be <code>bursting</code>, <code>provisioned</code>, or <code>elastic</code>. If you set <code>ThroughputMode</code> to <code>provisioned</code>, you must also set a value for <code>ProvisionedThroughputInMibps</code>. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, with certain time restrictions. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput\">Specifying throughput with provisioned mode</a> in the Amazon EFS User Guide. Default is <code>bursting</code>.","type":"string","enum":["bursting","provisioned","elastic"]},"ProvisionedThroughputInMibps":{"description":"The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if <code>ThroughputMode</code> is set to <code>provisioned</code>. The upper limit for throughput is 1024 MiB/s. To increase this limit, contact Amazon Web Services Support. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits\">Amazon EFS quotas that you can increase</a> in the Amazon EFS User Guide.","type":"number","format":"double","minimum":1},"AvailabilityZoneName":{"description":"Used to create a file system that uses One Zone storage classes. It specifies the Amazon Web Services Availability Zone in which to create the file system. Use the format <code>us-east-1a</code> to specify the Availability Zone. For more information about One Zone storage classes, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html\">Using EFS storage classes</a> in the Amazon EFS User Guide. <note> One Zone storage classes are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available. </note>","type":"string","pattern":".+","minLength":1,"maxLength":64},"Backup":{"description":"Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to <code>true</code> to enable automatic backups. If you are creating a file system that uses One Zone storage classes, automatic backups are enabled by default. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups\">Automatic backups</a> in the Amazon EFS User Guide. Default is <code>false</code>. However, if you specify an <code>AvailabilityZoneName</code>, the default is <code>true</code>. <note> Backup is not available in all Amazon Web Services Regions where Amazon EFS is available. </note>","type":"boolean"},"Tags":{"description":"Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a <code>\"Key\":\"Name\",\"Value\":\"{value}\"</code> key-value pair. Each key must be unique. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the Amazon Web Services General Reference Guide.","type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"DescribeFileSystems","description":"Returns the description of a specific Amazon EFS file system if either the file system <code>CreationToken</code> or the <code>FileSystemId</code> 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 <code>MaxItems</code> 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 <code>NextMarker</code>, an opaque token, in the response. In this case, you should send a subsequent request with the <code>Marker</code> request parameter set to the value of <code>NextMarker</code>. To retrieve a list of your file system descriptions, this operation is used in an iterative process, where <code>DescribeFileSystems</code> is called first without the <code>Marker</code> and then the operation continues to call it with the <code>Marker</code> parameter set to the value of the <code>NextMarker</code> from the previous response until the response has no <code>NextMarker</code>. The order of file systems returned in the response of one <code>DescribeFileSystems</code> call and the order of file systems returned across the responses of a multi-call iteration is unspecified. This operation requires permissions for the <code>elasticfilesystem:DescribeFileSystems</code> action. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeFileSystemsResponse"}}}},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}},"482":{"description":"FileSystemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemNotFound"}}}}},"parameters":[{"name":"MaxItems","in":"query","required":false,"description":"(Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems. ","schema":{"type":"integer","minimum":1}},{"name":"Marker","in":"query","required":false,"description":"(Optional) Opaque pagination token returned from a previous <code>DescribeFileSystems</code> operation (String). If present, specifies to continue the list from where the returning call had left off. ","schema":{"type":"string","pattern":".+","minLength":1,"maxLength":128}},{"name":"CreationToken","in":"query","required":false,"description":"(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.","schema":{"type":"string","pattern":".+","minLength":1,"maxLength":64}},{"name":"FileSystemId","in":"query","required":false,"description":"(Optional) ID of the file system whose description you want to retrieve (String).","schema":{"type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$","maxLength":128}}]}},"/2015-02-01/mount-targets":{"post":{"operationId":"CreateMountTarget","description":"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 <code>AvailabilityZoneName</code> and <code>AvailabiltyZoneId</code> properties in the <a>DescribeFileSystems</a> response object to get this information. Use the <code>subnetId</code> associated with the file system's Availability Zone when creating the mount target. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. To create a mount target for a file system, the file system's lifecycle state must be <code>available</code>. For more information, see <a>DescribeFileSystems</a>. In the request, provide the following: <ul> <li> The file system ID for which you are creating the mount target. </li> <li> A subnet ID, which determines the following: <ul> <li> The VPC in which Amazon EFS creates the mount target </li> <li> The Availability Zone in which Amazon EFS creates the mount target </li> <li> 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) </li> </ul> </li> </ul> After creating the mount target, Amazon EFS returns a response that includes, a <code>MountTargetId</code> and an <code>IpAddress</code>. 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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation\">How it Works: Implementation Overview</a>. 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: <ul> <li> Must belong to the same VPC as the subnets of the existing mount targets </li> <li> Must not be in the same Availability Zone as any of the subnets of the existing mount targets </li> </ul> If the request satisfies the requirements, Amazon EFS does the following: <ul> <li> Creates a new mount target in the specified subnet. </li> <li> Also creates a new network interface in the subnet as follows: <ul> <li> If the request provides an <code>IpAddress</code>, 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 <code>CreateNetworkInterface</code> call does when a request does not specify a primary private IP address). </li> <li> If the request provides <code>SecurityGroups</code>, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. </li> <li> Assigns the description <code>Mount target fsmt-id for file system fs-id </code> where <code> fsmt-id </code> is the mount target ID, and <code> fs-id </code> is the <code>FileSystemId</code>. </li> <li> Sets the <code>requesterManaged</code> property of the network interface to <code>true</code>, and the <code>requesterId</code> value to <code>EFS</code>. </li> </ul> Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the <code>NetworkInterfaceId</code> field in the mount target's description to the network interface ID, and the <code>IpAddress</code> field to its address. If network interface creation fails, the entire <code>CreateMountTarget</code> operation fails. </li> </ul> <note> The <code>CreateMountTarget</code> call returns only after creating the network interface, but while the mount target state is still <code>creating</code>, you can check the mount target creation status by calling the <a>DescribeMountTargets</a> operation, which among other things returns the mount target state. </note> 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 <a href=\"http://aws.amazon.com/efs/\">Amazon EFS</a>. 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: <ul> <li> <code>elasticfilesystem:CreateMountTarget</code> </li> </ul> This operation also requires permissions for the following Amazon EC2 actions: <ul> <li> <code>ec2:DescribeSubnets</code> </li> <li> <code>ec2:DescribeNetworkInterfaces</code> </li> <li> <code>ec2:CreateNetworkInterface</code> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MountTargetDescription"}}}},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}},"482":{"description":"FileSystemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemNotFound"}}}},"483":{"description":"IncorrectFileSystemLifeCycleState","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncorrectFileSystemLifeCycleState"}}}},"484":{"description":"MountTargetConflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MountTargetConflict"}}}},"485":{"description":"SubnetNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubnetNotFound"}}}},"486":{"description":"NoFreeAddressesInSubnet","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoFreeAddressesInSubnet"}}}},"487":{"description":"IpAddressInUse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpAddressInUse"}}}},"488":{"description":"NetworkInterfaceLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkInterfaceLimitExceeded"}}}},"489":{"description":"SecurityGroupLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityGroupLimitExceeded"}}}},"490":{"description":"SecurityGroupNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityGroupNotFound"}}}},"491":{"description":"UnsupportedAvailabilityZone","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedAvailabilityZone"}}}},"492":{"description":"AvailabilityZonesMismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityZonesMismatch"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileSystemId","SubnetId"],"properties":{"FileSystemId":{"description":"The ID of the file system for which to create the mount target.","type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$","maxLength":128},"SubnetId":{"description":"The ID of the subnet to add the mount target in. For file systems that use One Zone storage classes, use the subnet that is associated with the file system's Availability Zone.","type":"string","pattern":"^subnet-[0-9a-f]{8,40}$","minLength":15,"maxLength":47},"IpAddress":{"description":"Valid IPv4 address within the address range of the specified subnet.","type":"string","pattern":"^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$","minLength":7,"maxLength":15},"SecurityGroups":{"description":"Up to five VPC security group IDs, of the form <code>sg-xxxxxxxx</code>. These must be for the same VPC as subnet specified.","type":"array","items":{"$ref":"#/components/schemas/SecurityGroup"},"maxItems":100}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"DescribeMountTargets","description":"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 <code>elasticfilesystem:DescribeMountTargets</code> action, on either the file system ID that you specify in <code>FileSystemId</code>, or on the file system of the mount target that you specify in <code>MountTargetId</code>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeMountTargetsResponse"}}}},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}},"482":{"description":"FileSystemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemNotFound"}}}},"483":{"description":"MountTargetNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MountTargetNotFound"}}}},"484":{"description":"AccessPointNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointNotFound"}}}}},"parameters":[{"name":"MaxItems","in":"query","required":false,"description":"(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.","schema":{"type":"integer","minimum":1}},{"name":"Marker","in":"query","required":false,"description":"(Optional) Opaque pagination token returned from a previous <code>DescribeMountTargets</code> operation (String). If present, it specifies to continue the list from where the previous returning call left off.","schema":{"type":"string","pattern":".+","minLength":1,"maxLength":128}},{"name":"FileSystemId","in":"query","required":false,"description":"(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an <code>AccessPointId</code> or <code>MountTargetId</code> is not included. Accepts either a file system ID or ARN as input.","schema":{"type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$","maxLength":128}},{"name":"MountTargetId","in":"query","required":false,"description":"(Optional) ID of the mount target that you want to have described (String). It must be included in your request if <code>FileSystemId</code> is not included. Accepts either a mount target ID or ARN as input.","schema":{"type":"string","pattern":"^fsmt-[0-9a-f]{8,40}$","minLength":13,"maxLength":45}},{"name":"AccessPointId","in":"query","required":false,"description":"(Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a <code>FileSystemId</code> or <code>MountTargetId</code> is not included in your request. Accepts either an access point ID or ARN as input.","schema":{"type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$","maxLength":128}}]}},"/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration":{"post":{"operationId":"CreateReplicationConfiguration","description":"Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html\">Amazon EFS replication</a> in the Amazon EFS User Guide. The replication configuration specifies the following: <ul> <li> 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. </li> <li> 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: <ul> <li> 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). </li> <li> 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 <a href=\"https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html\"> Amazon EFS storage classes</a> in the Amazon EFS User Guide. </li> <li> 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. <note> After the file system is created, you cannot change the KMS key. </note> </li> </ul> </li> </ul> The following properties are set by default: <ul> <li> 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. </li> <li> 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. </li> </ul> The following properties are turned off by default: <ul> <li> 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. </li> <li> Automatic backups - Automatic daily backups not enabled on the destination file system. After the file system is created, you can change this setting. </li> </ul> For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html\">Amazon EFS replication</a> in the Amazon EFS User Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplicationConfigurationDescription"}}}},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"IncorrectFileSystemLifeCycleState","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncorrectFileSystemLifeCycleState"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ReplicationNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplicationNotFound"}}}},"484":{"description":"FileSystemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemNotFound"}}}},"485":{"description":"UnsupportedAvailabilityZone","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedAvailabilityZone"}}}},"486":{"description":"FileSystemLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemLimitExceeded"}}}},"487":{"description":"InsufficientThroughputCapacity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsufficientThroughputCapacity"}}}},"488":{"description":"ThroughputLimitExceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThroughputLimitExceeded"}}}},"489":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}},"parameters":[{"name":"SourceFileSystemId","in":"path","required":true,"description":"Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.","schema":{"type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$","maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Destinations"],"properties":{"Destinations":{"description":"An array of destination configuration objects. Only one destination configuration object is supported.","type":"array","items":{"$ref":"#/components/schemas/DestinationToCreate"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteReplicationConfiguration","description":"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 <code>Writeable</code>.","responses":{"204":{"description":"Success"},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}},"482":{"description":"FileSystemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemNotFound"}}}},"483":{"description":"ReplicationNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplicationNotFound"}}}}},"parameters":[{"name":"SourceFileSystemId","in":"path","required":true,"description":"The ID of the source file system in the replication configuration.","schema":{"type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$","maxLength":128}}]}},"/2015-02-01/create-tags/{FileSystemId}":{"post":{"deprecated":true,"operationId":"CreateTags","description":"<note> DEPRECATED - <code>CreateTags</code> is deprecated and not maintained. To create tags for EFS resources, use the API action. </note> 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 <code>Name</code> tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> operation. This operation requires permission for the <code>elasticfilesystem:CreateTags</code> action.","responses":{"204":{"description":"Success"},"480":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"481":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}},"482":{"description":"FileSystemNotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSystemNotFound"}}}}},"parameters":[{"name":"FileSystemId","in":"path","required":true,"description":"The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.","schema":{"type":"string","pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$","maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Tags"],"properties":{"Tags":{"description":"An array of <code>Tag</code> objects to add. Each <code>Tag</code> object is a key-value pair. ","type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}}}}},"parameters":[{"$ref":"#/components/param