{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.efs#AccessPointAlreadyExists": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" }, "AccessPointId": { "target": "com.amazonaws.efs#AccessPointId", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "
Returned if the access point that you are trying to create already exists, with the\n creation token you provided in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#AccessPointArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}$" } }, "com.amazonaws.efs#AccessPointDescription": { "type": "structure", "members": { "ClientToken": { "target": "com.amazonaws.efs#ClientToken", "traits": { "smithy.api#documentation": "The opaque string specified in the request to ensure idempotent creation.
" } }, "Name": { "target": "com.amazonaws.efs#Name", "traits": { "smithy.api#documentation": "The name of the access point. This is the value of the Name tag.
The tags associated with the access point, presented as an array of Tag objects.
" } }, "AccessPointId": { "target": "com.amazonaws.efs#AccessPointId", "traits": { "smithy.api#documentation": "The ID of the access point, assigned by Amazon EFS.
" } }, "AccessPointArn": { "target": "com.amazonaws.efs#AccessPointArn", "traits": { "smithy.api#documentation": "The unique Amazon Resource Name (ARN) associated with the access\n point.
" } }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "The ID of the EFS file system that the access point applies to.
" } }, "PosixUser": { "target": "com.amazonaws.efs#PosixUser", "traits": { "smithy.api#documentation": "The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by\n NFS clients using the access point.
" } }, "RootDirectory": { "target": "com.amazonaws.efs#RootDirectory", "traits": { "smithy.api#documentation": "The directory on the EFS file system that the access point exposes as the root\n directory to NFS clients using the access point.
" } }, "OwnerId": { "target": "com.amazonaws.efs#AwsAccountId", "traits": { "smithy.api#documentation": "Identifies the Amazon Web Services account that owns the access point resource.
" } }, "LifeCycleState": { "target": "com.amazonaws.efs#LifeCycleState", "traits": { "smithy.api#documentation": "Identifies the lifecycle phase of the access point.
" } } }, "traits": { "smithy.api#documentation": "Provides a description of an EFS file system access point.
" } }, "com.amazonaws.efs#AccessPointDescriptions": { "type": "list", "member": { "target": "com.amazonaws.efs#AccessPointDescription" } }, "com.amazonaws.efs#AccessPointId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$" } }, "com.amazonaws.efs#AccessPointLimitExceeded": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the Amazon Web Services account has already created the maximum number of access points\n 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.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.efs#AccessPointNotFound": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the specified AccessPointId value doesn't exist in the\n requester's Amazon Web Services account.
Returned if the Availability Zone that was specified for a mount target is \n different from the Availability Zone that was specified for One Zone storage.\n For more information, see Regional and One Zone storage redundancy.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.efs#AwsAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 14 }, "smithy.api#pattern": "^(\\d{12})|(\\d{4}-\\d{4}-\\d{4})$" } }, "com.amazonaws.efs#Backup": { "type": "boolean" }, "com.amazonaws.efs#BackupPolicy": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.efs#Status", "traits": { "smithy.api#documentation": "Describes the status of the file system's backup policy.
\n\n \n ENABLED\n \u2013 EFS is automatically\n backing up the file system.
\n \n ENABLING\n \u2013 EFS is turning on\n automatic backups for the file system.
\n \n DISABLED\n \u2013 Automatic back ups are turned\n off for the file system.
\n \n DISABLING\n \u2013 EFS is turning off\n automatic backups for the file system.
The backup policy for the file system used to create automatic daily backups. If status has a value of \n ENABLED, the file system is being automatically backed up. For more information, see Automatic backups.
Describes the file system's backup policy, indicating whether automatic backups are\n turned on or off.
" } } } }, "com.amazonaws.efs#BadRequest": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the request is malformed or contains an error such as an invalid\n parameter value or a missing required parameter.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.efs#BypassPolicyLockoutSafetyCheck": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.efs#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^.+$" } }, "com.amazonaws.efs#ConflictException": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode" }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#CreateAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.efs#CreateAccessPointRequest" }, "output": { "target": "com.amazonaws.efs#AccessPointDescription" }, "errors": [ { "target": "com.amazonaws.efs#AccessPointAlreadyExists" }, { "target": "com.amazonaws.efs#AccessPointLimitExceeded" }, { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#IncorrectFileSystemLifeCycleState" }, { "target": "com.amazonaws.efs#InternalServerError" }, { "target": "com.amazonaws.efs#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Creates an EFS access point. An access point is an application-specific view\n into an EFS file system that applies an operating system user and group, and a file\n system path, to any file system request made through the access point. The operating system\n user and group override any identity information provided by the NFS client. The file system\n path is exposed as the access point's root directory. Applications using the access point can\n only access data in the application's own directory and any subdirectories. A file system can\n have a maximum of 10,000 access points unless you request an increase. To learn more, see\n Mounting a file\n system using EFS access points.
\nIf multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of access points, you may experience a\n throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.
\nThis operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
Access points can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource action. For more\n information, see Granting\n permissions to tag resources during creation.
A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent\n creation.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.efs#Tags", "traits": { "smithy.api#documentation": "Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more \n information, see Tagging Amazon Web Services resources\n in the Amazon Web Services General Reference Guide.
" } }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "The ID of the EFS file system that the access point provides access to.
", "smithy.api#required": {} } }, "PosixUser": { "target": "com.amazonaws.efs#PosixUser", "traits": { "smithy.api#documentation": "The operating system user and\n group applied to all file system requests made using the access point.
" } }, "RootDirectory": { "target": "com.amazonaws.efs#RootDirectory", "traits": { "smithy.api#documentation": "Specifies the directory on the EFS file system that the access point exposes as\n the root directory of your file system to NFS clients using the access point. The clients\n using the access point can only access the root directory and below. If the\n RootDirectory > Path specified does not exist, Amazon EFS creates it and applies the CreationInfo settings when a client connects to an\n access point. When specifying a RootDirectory, you must provide the\n Path, and the CreationInfo.
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. \n If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount \n using the access point will fail.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.efs#CreateFileSystem": { "type": "operation", "input": { "target": "com.amazonaws.efs#CreateFileSystemRequest" }, "output": { "target": "com.amazonaws.efs#FileSystemDescription" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemAlreadyExists" }, { "target": "com.amazonaws.efs#FileSystemLimitExceeded" }, { "target": "com.amazonaws.efs#InsufficientThroughputCapacity" }, { "target": "com.amazonaws.efs#InternalServerError" }, { "target": "com.amazonaws.efs#ThroughputLimitExceeded" }, { "target": "com.amazonaws.efs#UnsupportedAvailabilityZone" } ], "traits": { "smithy.api#documentation": "Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:
\nCreates a new, empty file system. The file system will have an Amazon EFS assigned\n ID, and an initial lifecycle state creating.
Returns with the description of the created file system.
\nOtherwise, this operation returns a FileSystemAlreadyExists error with the\n ID of the existing file system.
For basic use cases, you can use a randomly generated UUID for the creation\n token.
\nThe idempotent operation allows you to retry a CreateFileSystem call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists error.
For more information, see \n Creating a file system\n in the Amazon EFS User Guide.
\nThe CreateFileSystem call returns while the file system's lifecycle\n state is still creating. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.
This operation accepts an optional PerformanceMode parameter that you choose\n for your file system. We recommend generalPurpose\n PerformanceMode for all file\n systems. The maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies\n than the generalPurpose mode. MaxIO mode is not supported for One Zone file systems or\n file systems that use Elastic throughput.
The PerformanceMode can't be changed after the file system has been\n created. For more information, see Amazon EFS performance\n modes.
You can set the throughput mode for the file system using the ThroughputMode\n parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to\n available, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount\n your Amazon EFS file system on an EC2 instances in your VPC by using the mount\n target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the\n elasticfilesystem:CreateFileSystem action.
File systems can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource action. For more\n information, see Granting permissions to tag resources during creation.
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent\n creation.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "PerformanceMode": { "target": "com.amazonaws.efs#PerformanceMode", "traits": { "smithy.api#documentation": "The performance mode of the file system. We recommend generalPurpose\n performance mode for all file systems. File systems using the maxIO performance\n mode can scale to higher levels of aggregate throughput and operations per second with a\n tradeoff of slightly higher latencies for most file operations. The performance mode\n can't be changed after the file system has been created. The maxIO mode is\n not supported on One Zone file systems.
Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
\nDefault is generalPurpose.
A Boolean value that, if true, creates an encrypted file system. When creating an\n encrypted file system, you have the option of specifying an existing Key Management Service key (KMS key).\n If you don't specify a KMS key, then the default KMS key for\n Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.\n
The ID of the KMS key that you want to use to protect the encrypted file\n 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\n formats:
\nKey ID - A unique identifier of the key, for example\n 1234abcd-12ab-34cd-56ef-1234567890ab.
ARN - An Amazon Resource Name (ARN) for the key, for example\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias - A previously created display name for a key, for example\n alias/projectKey1.
Key alias ARN - An ARN for a key alias, for example\n arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
If you use KmsKeyId, you must set the CreateFileSystemRequest$Encrypted \n parameter to true.
EFS accepts only symmetric KMS keys. You cannot use asymmetric \n KMS keys with Amazon EFS file systems.
\nSpecifies the throughput mode for the file system. The mode can be bursting,\n provisioned, or elastic. If you set ThroughputMode to\n provisioned, you must also set a value for\n ProvisionedThroughputInMibps. After you create the file system, you can\n decrease your file system's Provisioned throughput or change between the\n throughput modes, with certain time restrictions. For more information, see Specifying\n throughput with provisioned mode in the Amazon EFS User\n Guide.
Default is bursting.
The throughput, measured in mebibytes per second (MiBps), that you want to provision for a\n file system that you're creating. Required if ThroughputMode is set to\n provisioned. Valid values are 1-3414 MiBps, with the upper limit depending on\n Region. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas\n that you can increase in the Amazon EFS User\n Guide.
For One Zone file systems, specify the Amazon Web Services\n Availability Zone in which to create the file system. Use the format us-east-1a to\n specify the Availability Zone. For more information about One Zone file systems, see\n EFS file system types in the Amazon EFS User Guide.
One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
\nSpecifies whether automatic backups are enabled on the file system that you are creating.\n Set the value to true to enable automatic backups. If you are creating a\n One Zone file system, automatic backups are enabled by default. For more\n information, see Automatic backups in the\n Amazon EFS User Guide.
Default is false. However, if you specify an AvailabilityZoneName, \n the default is true.
Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
\nUse to create one or more tags associated with the file system. Each\n tag is a user-defined key-value pair. Name your file system on creation by including a\n \"Key\":\"Name\",\"Value\":\"{value}\" key-value pair. Each key must be unique. For more \n information, see Tagging Amazon Web Services resources\n in the Amazon Web Services General Reference Guide.
Creates a mount target for a file system. You can then mount the file system on EC2\n instances by using the mount target.
\nYou can create one mount target in each Availability Zone in your VPC. All EC2 instances\n in a VPC within a given Availability Zone share a single mount target for a given file system. If\n you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets.\n EC2 instances do not need to be in the same subnet as the mount target in order to\n access their file system.
\nYou can create only one mount target for a One Zone file system. You must\n create that mount target in the same Availability Zone in which the file system is located. Use the\n AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the\n subnetId associated with the file system's Availability Zone when creating the mount\n target.
For more information, see Amazon EFS: How it Works.
\nTo create a mount target for a file system, the file system's lifecycle state must be\n available. For more information, see DescribeFileSystems.
In the request, provide the following:
\nThe file system ID for which you are creating the mount\n target.
\nA subnet ID, which determines the following:
\nThe VPC in which Amazon EFS creates the mount target
\nThe Availability Zone in which Amazon EFS creates the mount target
\nThe IP address range from which Amazon EFS selects the IP address of the mount target\n (if you don't specify an IP address in the request)
\nAfter creating the mount target, Amazon EFS returns a response that includes, a\n MountTargetId and an IpAddress. You use this IP address when\n mounting the file system in an EC2 instance. You can also use the mount target's\n DNS name when mounting the file system. The EC2 instance on which you mount the file\n system by using the mount target can resolve the mount target's DNS name to its IP\n address. For more information, see How it Works:\n Implementation Overview.
Note that you can create mount targets for a file system in only one VPC, and there can be\n only one mount target per Availability Zone. That is, if the file system already has one or more\n mount targets created for it, the subnet specified in the request to add another mount target\n must meet the following requirements:
\nMust belong to the same VPC as the subnets of the existing mount targets
\nMust not be in the same Availability Zone as any of the subnets of the existing mount\n targets
\nIf the request satisfies the requirements, Amazon EFS does the following:
\nCreates a new mount target in the specified subnet.
\nAlso creates a new network interface in the subnet as follows:
\nIf the request provides an IpAddress, Amazon EFS assigns that\n IP address to the network interface. Otherwise, Amazon EFS assigns a free\n address in the subnet (in the same way that the Amazon EC2\n CreateNetworkInterface call does when a request does not specify a\n primary private IP address).
If the request provides SecurityGroups, this network interface is\n associated with those security groups. Otherwise, it belongs to the default security\n group for the subnet's VPC.
Assigns the description Mount target fsmt-id for\n file system fs-id\n where \n fsmt-id\n is the mount target ID, and \n fs-id\n is the FileSystemId.
Sets the requesterManaged property of the network interface to\n true, and the requesterId value to\n EFS.
Each Amazon EFS mount target has one corresponding requester-managed\n EC2 network interface. After the network interface is created, Amazon EFS\n sets the NetworkInterfaceId field in the mount target's description to\n the network interface ID, and the IpAddress field to its address. If network\n interface creation fails, the entire CreateMountTarget operation\n fails.
The CreateMountTarget call returns only after creating the network\n interface, but while the mount target state is still creating, you can check\n the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount\n target state.
We recommend that you create a mount target in each of the Availability Zones. There are cost\n considerations for using a file system in an Availability Zone through a mount target created in\n another Availability Zone. For more information, see Amazon EFS pricing. In addition, by always using a mount target local to the\n instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in\n which your mount target is created goes down, then you can't access your file system\n through that mount target.
\nThis operation requires permissions for the following action on the file\n system:
\n\n elasticfilesystem:CreateMountTarget\n
This operation also requires permissions for the following Amazon EC2\n actions:
\n\n ec2:DescribeSubnets\n
\n ec2:DescribeNetworkInterfaces\n
\n ec2:CreateNetworkInterface\n
The ID of the file system for which to create the mount target.
", "smithy.api#required": {} } }, "SubnetId": { "target": "com.amazonaws.efs#SubnetId", "traits": { "smithy.api#documentation": "The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet\n that is associated with the file system's Availability Zone.
", "smithy.api#required": {} } }, "IpAddress": { "target": "com.amazonaws.efs#IpAddress", "traits": { "smithy.api#documentation": "If the IP address type for the mount target is IPv4, then specify the IPv4 address within\n the address range of the specified subnet.
" } }, "Ipv6Address": { "target": "com.amazonaws.efs#Ipv6Address", "traits": { "smithy.api#documentation": "If the IP address type for the mount target is IPv6, then specify the IPv6 address within\n the address range of the specified subnet.
" } }, "IpAddressType": { "target": "com.amazonaws.efs#IpAddressType", "traits": { "smithy.api#documentation": "Specify the type of IP address of the mount target you are creating. Options are IPv4,\n dual stack, or IPv6. If you don\u2019t specify an IpAddressType, then IPv4 is used.
\nIPV4_ONLY \u2013 Create mount target with IPv4 only subnet or dual-stack subnet.
\nDUAL_STACK \u2013 Create mount target with dual-stack subnet.
\nIPV6_ONLY \u2013 Create mount target with IPv6 only subnet.
\nCreating IPv6 mount target only ENI in dual-stack subnet is not supported.
\nVPC security group IDs, of the form sg-xxxxxxxx. These must be for the same\n VPC as the subnet specified. The maximum number of security groups depends on account quota.\n For more information, see Amazon VPC Quotas\n in the Amazon VPC User Guide (see the Security Groups\n table).\n
Creates a replication con\ufb01guration to either a new or existing EFS file system.\n For more information, see Amazon EFS replication in the Amazon EFS User\n Guide. The replication configuration specifies the following:
\n\n Source file system \u2013 The EFS file\n system that you want to replicate.
\n\n Destination file system \u2013 The destination file\n system to which the source file system is replicated. There can only be one destination\n file system in a replication configuration.
\nA file system can be part of only one replication configuration.
\nThe destination parameters for the replication configuration depend on\n whether you are replicating to a new file system or to an existing file system, and if you\n are replicating across Amazon Web Services accounts. See DestinationToCreate for more information.
\nThis operation requires permissions for the elasticfilesystem:CreateReplicationConfiguration\n action. Additionally, other permissions are required depending on how you are replicating file systems.\n For more information, see Required permissions for replication\n in the Amazon EFS User\n Guide.
Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be \n a source or destination file system in another replication configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Destinations": { "target": "com.amazonaws.efs#DestinationsToCreate", "traits": { "smithy.api#documentation": "An array of destination configuration objects. Only one destination configuration object is supported.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.efs#CreateTags": { "type": "operation", "input": { "target": "com.amazonaws.efs#CreateTagsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#InternalServerError" } ], "traits": { "smithy.api#deprecated": { "message": "Use TagResource." }, "smithy.api#documentation": "DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS\n resources, use the API action.
Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If\n a tag key specified in the request already exists on the file system, this operation\n overwrites its value with the value provided in the request. If you add the Name\n tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.
This operation requires permission for the elasticfilesystem:CreateTags\n action.
The ID of the file system whose tags you want to modify (String). This operation modifies\n the tags only, not the file system.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.efs#Tags", "traits": { "smithy.api#documentation": "An array of Tag objects to add. Each Tag object is a key-value\n pair.
Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.
Required if the RootDirectory > Path specified does not exist. \n Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory > Path. \n If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. \n When specifying CreationInfo, you must include values for all properties. \n
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. \n If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount \n using the access point will fail.
\nIf you do not provide CreationInfo and the specified RootDirectory does not exist, \n attempts to mount the file system using the access point will fail.
Deletes the specified access point. After deletion is complete, new clients can no \n longer connect to the access points. Clients connected to the access point at the time of \n deletion will continue to function until they terminate their connection.
\nThis operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.
The ID of the access point that you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.efs#DeleteFileSystem": { "type": "operation", "input": { "target": "com.amazonaws.efs#DeleteFileSystemRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemInUse" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#InternalServerError" } ], "traits": { "smithy.api#documentation": "Deletes a file system, permanently severing access to its contents. Upon return, the\n file system no longer exists and you can't access any contents of the deleted file\n system.
\nYou need to manually delete mount targets attached to a file system before you can delete\n an EFS file system. This step is performed for you when you use the Amazon Web Services console \n to delete a file system.
\nYou cannot delete a file system that is part of an EFS replication configuration. \n You need to delete the replication configuration first.
\nYou can't delete a file system that is in use. That is, if the file system has\n any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.
\nThe DeleteFileSystem call returns while the file system state is still\n deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound\n error.
This operation requires permissions for the\n elasticfilesystem:DeleteFileSystem action.
Deletes the FileSystemPolicy for the specified file system. \n The default FileSystemPolicy goes into effect once the existing policy is deleted. \n 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.
Specifies the EFS file system for which to delete the\n FileSystemPolicy.
The ID of the file system you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.efs#DeleteMountTarget": { "type": "operation", "input": { "target": "com.amazonaws.efs#DeleteMountTargetRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#DependencyTimeout" }, { "target": "com.amazonaws.efs#InternalServerError" }, { "target": "com.amazonaws.efs#MountTargetNotFound" } ], "traits": { "smithy.api#documentation": "Deletes the specified mount target.
\nThis operation forcibly breaks any mounts of the file system by using the mount target\n that is being deleted, which might disrupt instances or applications using those mounts. To\n avoid applications getting cut off abruptly, you might consider unmounting any mounts of the\n mount target, if feasible. The operation also deletes the associated network interface.\n Uncommitted writes might be lost, but breaking a mount target using this operation does not\n corrupt the file system itself. The file system you created remains. You can mount an\n EC2 instance in your VPC by using another mount target.
\nThis operation requires permissions for the following action on the file\n system:
\n\n elasticfilesystem:DeleteMountTarget\n
The DeleteMountTarget call returns while the mount target state is still\n deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target\n descriptions for the given file system.
The operation also requires permissions for the following Amazon EC2 action on the\n mount target's network interface:
\n\n ec2:DeleteNetworkInterface\n
The ID of the mount target to delete (String).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.efs#DeleteReplicationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.efs#DeleteReplicationConfigurationRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#InternalServerError" }, { "target": "com.amazonaws.efs#ReplicationNotFound" } ], "traits": { "smithy.api#documentation": "Deletes a replication configuration. Deleting a replication configuration ends the\n replication process. After a replication configuration is deleted, the destination file system\n becomes Writeable and its replication overwrite protection is re-enabled. For\n more information, see Delete a replication configuration.
This operation requires permissions for the\n elasticfilesystem:DeleteReplicationConfiguration action.
The ID of the source file system in the replication configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DeletionMode": { "target": "com.amazonaws.efs#DeletionMode", "traits": { "smithy.api#documentation": "When replicating across Amazon Web Services accounts or across Amazon Web Services Regions, \n Amazon EFS deletes the replication configuration from both the source \n and destination account or Region (ALL_CONFIGURATIONS) by default. \n If there's a configuration or permissions issue that prevents Amazon EFS from deleting the \n replication configuration from both sides, you can use the LOCAL_CONFIGURATION_ONLY mode\n to delete the replication configuration from only the local side (the account\n or Region from which the delete is performed).
Only use the LOCAL_CONFIGURATION_ONLY mode in the case that Amazon EFS is unable\n to delete the replication configuration in both the source and destination account or Region. \n Deleting the local configuration \n leaves the configuration in the other account or Region unrecoverable.
Additionally, do not use this mode for same-account, same-region replication as doing so results in a \n BadRequest exception error.
\nDEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS\n resources, use the API action.
Deletes the specified tags from a file system. If the DeleteTags request\n includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an\n error. For more information about tags and related restrictions, see Tag restrictions in the\n Billing and Cost Management User Guide.
This operation requires permissions for the elasticfilesystem:DeleteTags\n action.
The ID of the file system whose tags you want to delete (String).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.efs#TagKeys", "traits": { "smithy.api#documentation": "A list of tag keys to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.efs#DeletionMode": { "type": "enum", "members": { "ALL_CONFIGURATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL_CONFIGURATIONS" } }, "LOCAL_CONFIGURATION_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOCAL_CONFIGURATION_ONLY" } } } }, "com.amazonaws.efs#DependencyTimeout": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The service timed out trying to fulfill the request, and the client should try the\n call again.
", "smithy.api#error": "server", "smithy.api#httpError": 504 } }, "com.amazonaws.efs#DescribeAccessPoints": { "type": "operation", "input": { "target": "com.amazonaws.efs#DescribeAccessPointsRequest" }, "output": { "target": "com.amazonaws.efs#DescribeAccessPointsResponse" }, "errors": [ { "target": "com.amazonaws.efs#AccessPointNotFound" }, { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns the description of a specific Amazon EFS access point if the\n AccessPointId is provided. If you provide an EFS\n FileSystemId, it returns descriptions of all access points for that file\n system. You can provide either an AccessPointId or a FileSystemId in\n the request, but not both.
This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
(Optional) When retrieving all access points for a file system,\n you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. \n The default value is 100.
\n NextToken is present if the response is paginated. You can use \n NextMarker in the subsequent request to fetch the next page of access point descriptions.
(Optional) Specifies an EFS access point to describe in the response; mutually\n exclusive with FileSystemId.
(Optional) If you provide a FileSystemId, EFS returns all access\n points for that file system; mutually exclusive with AccessPointId.
An array of access point descriptions.
" } }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "Present if there are more access points than returned in the response. \n You can use the NextMarker in the subsequent request to fetch the additional descriptions.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.efs#DescribeAccountPreferences": { "type": "operation", "input": { "target": "com.amazonaws.efs#DescribeAccountPreferencesRequest" }, "output": { "target": "com.amazonaws.efs#DescribeAccountPreferencesResponse" }, "errors": [ { "target": "com.amazonaws.efs#InternalServerError" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "GET", "uri": "/2015-02-01/account-preferences", "code": 200 } } }, "com.amazonaws.efs#DescribeAccountPreferencesRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "(Optional) You can use NextToken in a subsequent request to fetch the next page of \n Amazon Web Services account preferences if the response payload was paginated.
(Optional) When retrieving account preferences,\n you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. \n The default value is 100.
Describes the resource ID preference setting for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
" } }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "Present if there are more records than returned in the response. \n You can use the NextToken in the subsequent request to fetch the additional descriptions.
Returns the backup policy for the specified EFS file system.
", "smithy.api#http": { "method": "GET", "uri": "/2015-02-01/file-systems/{FileSystemId}/backup-policy", "code": 200 } } }, "com.amazonaws.efs#DescribeBackupPolicyRequest": { "type": "structure", "members": { "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "Specifies which EFS file system for which to retrieve the\n BackupPolicy.
Returns the FileSystemPolicy for the specified EFS file\n system.
This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
Specifies which EFS file system to retrieve the FileSystemPolicy\n for.
Returns the description of a specific Amazon EFS file system if either the file system\n CreationToken or the FileSystemId is provided. Otherwise, it\n returns descriptions of all file systems owned by the caller's Amazon Web Services account in the \n Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the\n MaxItems parameter to limit the number of descriptions in a response.\n This number is automatically set to 100. If more file system descriptions remain,\n Amazon EFS returns a NextMarker, an opaque token, in the response. In this case,\n you should send a subsequent request with the Marker request parameter set to the\n value of NextMarker.
To retrieve a list of your file system descriptions, this operation is used in an\n iterative process, where DescribeFileSystems is called first without the\n Marker and then the operation continues to call it with the Marker\n parameter set to the value of the NextMarker from the previous response until the\n response has no NextMarker.
The order of file systems returned in the response of one\n DescribeFileSystems call and the order of file systems returned across the\n responses of a multi-call iteration is unspecified.
This operation requires permissions for the\n elasticfilesystem:DescribeFileSystems action.
(Optional) Specifies the maximum number of file systems to return in the response\n (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.\n
", "smithy.api#httpQuery": "MaxItems" } }, "Marker": { "target": "com.amazonaws.efs#Marker", "traits": { "smithy.api#documentation": "(Optional) Opaque pagination token returned from a previous\n DescribeFileSystems operation (String). If present, specifies to continue the\n list from where the returning call had left off.
(Optional) Restricts the list to the file system with this creation token (String). You\n specify a creation token when you create an Amazon EFS file system.
", "smithy.api#httpQuery": "CreationToken" } }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "(Optional) ID of the file system whose description you want to retrieve\n (String).
", "smithy.api#httpQuery": "FileSystemId" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.efs#DescribeFileSystemsResponse": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.efs#Marker", "traits": { "smithy.api#documentation": "Present if provided by caller in the request (String).
" } }, "FileSystems": { "target": "com.amazonaws.efs#FileSystemDescriptions", "traits": { "smithy.api#documentation": "An array of file system descriptions.
" } }, "NextMarker": { "target": "com.amazonaws.efs#Marker", "traits": { "smithy.api#documentation": "Present if there are more file systems than returned in the response (String). You can\n use the NextMarker in the subsequent request to fetch the descriptions.
Returns the current LifecycleConfiguration object for the specified\n EFS file system. Lifecycle management uses the LifecycleConfiguration\n object to identify when to move files between storage classes. For a file system without a\n LifecycleConfiguration object, the call returns an empty array in the\n response.
This operation requires permissions for the\n elasticfilesystem:DescribeLifecycleConfiguration operation.
The ID of the file system whose LifecycleConfiguration object you want to\n retrieve (String).
Returns the security groups currently in effect for a mount target. This operation\n requires that the network interface of the mount target has been created and the lifecycle\n state of the mount target is not deleted.
This operation requires permissions for the following actions:
\n\n elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount\n target's file system.
\n ec2:DescribeNetworkInterfaceAttribute action on the mount target's\n network interface.
The ID of the mount target whose security groups you want to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.efs#DescribeMountTargetSecurityGroupsResponse": { "type": "structure", "members": { "SecurityGroups": { "target": "com.amazonaws.efs#SecurityGroups", "traits": { "smithy.api#documentation": "An array of security groups.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.efs#DescribeMountTargets": { "type": "operation", "input": { "target": "com.amazonaws.efs#DescribeMountTargetsRequest" }, "output": { "target": "com.amazonaws.efs#DescribeMountTargetsResponse" }, "errors": [ { "target": "com.amazonaws.efs#AccessPointNotFound" }, { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#InternalServerError" }, { "target": "com.amazonaws.efs#MountTargetNotFound" } ], "traits": { "smithy.api#documentation": "Returns the descriptions of all the current mount targets, or a specific mount target,\n for a file system. When requesting all of the current mount targets, the order of mount\n targets returned in the response is unspecified.
\nThis operation requires permissions for the\n elasticfilesystem:DescribeMountTargets action, on either the file system ID\n that you specify in FileSystemId, or on the file system of the mount target that\n you specify in MountTargetId.
(Optional) Maximum number of mount targets to return in the response. Currently, this\n number is automatically set to\n 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.
", "smithy.api#httpQuery": "MaxItems" } }, "Marker": { "target": "com.amazonaws.efs#Marker", "traits": { "smithy.api#documentation": "(Optional) Opaque pagination token returned from a previous\n DescribeMountTargets operation (String). If present, it specifies to continue\n the list from where the previous returning call left off.
(Optional) ID of the file system whose mount targets you want to list (String). It must\n be included in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.
(Optional) ID of the mount target that you want to have described (String). It must be\n included in your request if FileSystemId is not included. Accepts either a mount target ID or ARN as input.
(Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a\n FileSystemId or MountTargetId is not included in your request. Accepts either an access point ID or ARN as input.
If the request included the Marker, the response returns that value in\n this field.
Returns the file system's mount targets as an array of\n MountTargetDescription objects.
If a value is present, there are more mount targets to return. In a subsequent request,\n you can provide Marker in your request with this value to retrieve the next set\n of mount targets.
Retrieves the replication configuration for a specific file system. If a file system is\n not specified, all of the replication configurations for the Amazon Web Services account in an\n Amazon Web Services Region are retrieved.
", "smithy.api#http": { "method": "GET", "uri": "/2015-02-01/file-systems/replication-configurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Replications", "pageSize": "MaxResults" } } }, "com.amazonaws.efs#DescribeReplicationConfigurationsRequest": { "type": "structure", "members": { "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "You can retrieve the replication configuration for a specific file system by providing its\n file system ID. For cross-account,cross-region replication, an account can only describe the replication\n configuration for a file system in its own Region.
", "smithy.api#httpQuery": "FileSystemId" } }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "\n NextToken is present if the response is paginated. You can use\n NextToken in a subsequent request to fetch the next page of\n output.
(Optional) To limit the number of objects returned in a response, you can specify the\n MaxItems parameter. The default value is 100.
The collection of replication configurations that is returned.
" } }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "You can use the NextToken from the previous response in a subsequent \n request to fetch the additional descriptions.
DEPRECATED - The DescribeTags action is deprecated and not maintained. To view\n tags associated with EFS resources, use the ListTagsForResource API\n action.
Returns the tags associated with a file system. The order of tags returned in the\n response of one DescribeTags call and the order of tags returned across the\n responses of a multiple-call iteration (when using pagination) is unspecified.
This operation requires permissions for the\n elasticfilesystem:DescribeTags action.
(Optional) The maximum number of file system tags to return in the response. Currently,\n this number is automatically set to\n 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.
", "smithy.api#httpQuery": "MaxItems" } }, "Marker": { "target": "com.amazonaws.efs#Marker", "traits": { "smithy.api#documentation": "(Optional) An opaque pagination token returned from a previous\n DescribeTags operation (String). If present, it specifies to continue the list\n from where the previous call left off.
The ID of the file system whose tag set you want to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.efs#DescribeTagsResponse": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.efs#Marker", "traits": { "smithy.api#documentation": "If the request included a Marker, the response returns that value in this\n field.
Returns tags associated with the file system as an array of Tag objects.\n
If a value is present, there are more tags to return. In a subsequent request, you can\n provide the value of NextMarker as the value of the Marker parameter\n in your next request to retrieve the next set of tags.
Describes the status of the replication configuration. For more information \n about replication status, see Viewing\n replication details in the Amazon EFS User Guide. \n
", "smithy.api#required": {} } }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "The ID of the destination Amazon EFS file system.
", "smithy.api#required": {} } }, "Region": { "target": "com.amazonaws.efs#RegionName", "traits": { "smithy.api#documentation": "The Amazon Web Services Region in which the destination file system is located.
", "smithy.api#required": {} } }, "LastReplicatedTimestamp": { "target": "com.amazonaws.efs#Timestamp", "traits": { "smithy.api#documentation": "The time when the most recent sync was successfully completed on the destination file\n system. Any changes to data on the source file system that occurred before this time have been\n successfully replicated to the destination file system. Any changes that occurred after this\n time might not be fully replicated.
" } }, "OwnerId": { "target": "com.amazonaws.efs#AwsAccountId", "traits": { "smithy.api#documentation": "ID of the Amazon Web Services account in which the destination file system resides.
" } }, "StatusMessage": { "target": "com.amazonaws.efs#StatusMessage", "traits": { "smithy.api#documentation": "Message that provides details about the PAUSED or ERRROR state \n of the replication destination configuration. For more information \n about replication status messages, see Viewing\n replication details in the Amazon EFS User Guide. \n
Amazon Resource Name (ARN) of the IAM role in the source account that allows\n Amazon EFS to perform replication on its behalf. This is optional for same-account\n replication and required for cross-account replication.
" } } }, "traits": { "smithy.api#documentation": "Describes the destination file system in the replication configuration.
" } }, "com.amazonaws.efs#DestinationToCreate": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.efs#RegionName", "traits": { "smithy.api#documentation": "To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system. The Region must be enabled\n for the Amazon Web Services account that owns the source file system. For more information, see\n Managing Amazon Web Services Regions in the Amazon Web Services General\n Reference Reference Guide.
" } }, "AvailabilityZoneName": { "target": "com.amazonaws.efs#AvailabilityZoneName", "traits": { "smithy.api#documentation": "To create a file system that uses One Zone storage, specify the name of the\n Availability Zone in which to create the destination file system.
" } }, "KmsKeyId": { "target": "com.amazonaws.efs#KmsKeyId", "traits": { "smithy.api#documentation": "Specify the Key Management Service (KMS) key that you want to use to\n encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,\n /aws/elasticfilesystem. This ID can be in one of the following formats:
Key ID - The unique identifier of the key, for example\n 1234abcd-12ab-34cd-56ef-1234567890ab.
ARN - The ARN for the key, for example\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias - A previously created display name for a key, for example\n alias/projectKey1.
Key alias ARN - The ARN for a key alias, for example\n arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
The ID or ARN of the file system to use for the destination. \n For cross-account replication, this must be an ARN. The file system's \n replication overwrite replication must be disabled. If no ID or ARN is \n specified, then a new file system is created.
\nWhen you initially configure replication to an existing file system, Amazon EFS\n writes data to or removes existing data from the destination file system to match data in\n the source file system. If you don't want to change data in the destination file system,\n then you should replicate to a new file system instead. For more information, see https://docs.aws.amazon.com/efs/latest/ug/create-replication.html.
\nAmazon Resource Name (ARN) of the IAM role in the source account that allows\n Amazon EFS to perform replication on its behalf. This is optional for same-account\n replication and required for cross-account replication.
" } } }, "traits": { "smithy.api#documentation": "Describes the new or existing destination file system for the replication\n configuration.
\nIf you want to replicate to a new file system, do not specify the File System ID\n for the destination file system. Amazon EFS creates a new, empty file system.\n For One Zone storage, specify the Availability Zone to create the file system in. To\n use an Key Management Service key other than the default KMS key, then\n specify it. For more information, see Configuring replication to new Amazon EFS file system in the Amazon EFS User\n Guide.
\nAfter the file system is created, you cannot change the KMS key or the performance mode.
\nIf you want to replicate to an existing file system that's in the same account\n as the source file system, then you need to \n provide the ID or Amazon Resource Name (ARN) of the file system to which to replicate. The file system's replication\n overwrite protection must be disabled. For more information, see Replicating to\n an existing file system in the Amazon EFS User\n Guide.
\nIf you are replicating the file system to a file system that's in a different account than the\n source file system (cross-account replication), you need to provide the ARN for the file system and the IAM role that allows Amazon EFS to perform\n replication on the destination account. The file system's replication overwrite protection\n must be disabled. For more information, see Replicating across Amazon Web Services accounts in the Amazon EFS User\n Guide.
\nThe error code is a string that uniquely identifies an error condition. \n It is meant to be read and understood by programs that detect and handle errors by type.
", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.efs#ErrorMessage": { "type": "string", "traits": { "smithy.api#documentation": "The error message contains a generic description of the error \n condition in English. It is intended for a human audience. Simple programs display the message directly \n to the end user if they encounter an error condition they don't know how or don't care to handle. \n Sophisticated programs with more exhaustive error handling and proper internationalization are \n more likely to ignore the error message.
" } }, "com.amazonaws.efs#FileSystemAlreadyExists": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Returned if the file system you are trying to create already exists, with the\n creation token you provided.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#FileSystemArn": { "type": "string" }, "com.amazonaws.efs#FileSystemDescription": { "type": "structure", "members": { "OwnerId": { "target": "com.amazonaws.efs#AwsAccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account that created the file system.
", "smithy.api#required": {} } }, "CreationToken": { "target": "com.amazonaws.efs#CreationToken", "traits": { "smithy.api#documentation": "The opaque string specified in the request.
", "smithy.api#required": {} } }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "The ID of the file system, assigned by Amazon EFS.
", "smithy.api#required": {} } }, "FileSystemArn": { "target": "com.amazonaws.efs#FileSystemArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the EFS file system, in the\n format\n arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id\n .\n Example with sample data:\n arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567\n
The time that the file system was created, in seconds (since\n 1970-01-01T00:00:00Z).
", "smithy.api#required": {} } }, "LifeCycleState": { "target": "com.amazonaws.efs#LifeCycleState", "traits": { "smithy.api#documentation": "The lifecycle phase of the file system.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.efs#TagValue", "traits": { "smithy.api#documentation": "You can add tags to a file system, including a Name tag. For more\n information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns\n the value in this field.
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
", "smithy.api#required": {} } }, "SizeInBytes": { "target": "com.amazonaws.efs#FileSystemSize", "traits": { "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the file system, in its\n Value field, and the time at which that size was determined in its\n Timestamp field. The Timestamp value is the integer number of\n seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent\n the size of a consistent snapshot of the file system, but it is eventually consistent when\n there are no writes to the file system. That is, SizeInBytes represents actual\n size only if the file system is not modified for a period longer than a couple of hours.\n Otherwise, the value is not the exact size that the file system was at any point in time.\n
The performance mode of the file system.
", "smithy.api#required": {} } }, "Encrypted": { "target": "com.amazonaws.efs#Encrypted", "traits": { "smithy.api#documentation": "A Boolean value that, if true, indicates that the file system is encrypted.
" } }, "KmsKeyId": { "target": "com.amazonaws.efs#KmsKeyId", "traits": { "smithy.api#documentation": "The ID of an KMS key used to protect the encrypted file system.
" } }, "ThroughputMode": { "target": "com.amazonaws.efs#ThroughputMode", "traits": { "smithy.api#documentation": "Displays the file system's throughput mode. For more information, see \n Throughput modes \n in the Amazon EFS User Guide.\n
" } }, "ProvisionedThroughputInMibps": { "target": "com.amazonaws.efs#ProvisionedThroughputInMibps", "traits": { "smithy.api#documentation": "The amount of provisioned throughput, measured in MiBps, for the file system. Valid for\n file systems using ThroughputMode set to provisioned.
Describes the Amazon Web Services Availability Zone in which the file system is located, and is\n valid only for One Zone file systems. For more information, see Using EFS storage\n classes in the Amazon EFS User Guide.
" } }, "AvailabilityZoneId": { "target": "com.amazonaws.efs#AvailabilityZoneId", "traits": { "smithy.api#documentation": "The unique and consistent identifier of the Availability Zone in which the file system is\n located, and is valid only for One Zone file systems. For example,\n use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and\n it has the same location in every Amazon Web Services account.
The tags associated with the file system, presented as an array of Tag\n objects.
Describes the protection on the file system.
" } } }, "traits": { "smithy.api#documentation": "A description of the file system.
" } }, "com.amazonaws.efs#FileSystemDescriptions": { "type": "list", "member": { "target": "com.amazonaws.efs#FileSystemDescription" } }, "com.amazonaws.efs#FileSystemId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$" } }, "com.amazonaws.efs#FileSystemInUse": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if a file system has mount targets.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#FileSystemLimitExceeded": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the Amazon Web Services account has already created the maximum number of file systems\n allowed per account.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.efs#FileSystemNotFound": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the specified FileSystemId value doesn't exist in the\n requester's Amazon Web Services account.
Specifies the EFS file system to which the FileSystemPolicy\n applies.
The JSON formatted FileSystemPolicy for the EFS file\n system.
The status of the file system's replication overwrite protection.
\n\n ENABLED \u2013 The file system cannot be used as the destination file\n system in a replication configuration. The file system is writeable. Replication overwrite\n protection is ENABLED by default.
\n DISABLED \u2013 The file system can be used as the destination file\n system in a replication configuration. The file system is read-only and can only be\n modified by EFS replication.
\n REPLICATING \u2013 The file system is being used as the destination\n file system in a replication configuration. The file system is read-only and is modified\n only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite\n protection is re-enabled, the file system becomes writeable.
" } } }, "traits": { "smithy.api#documentation": "Describes the protection on a file system.
" } }, "com.amazonaws.efs#FileSystemSize": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.efs#FileSystemSizeValue", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the file system.
", "smithy.api#required": {} } }, "Timestamp": { "target": "com.amazonaws.efs#Timestamp", "traits": { "smithy.api#documentation": "The time at which the size of data, returned in the Value field, was\n determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
The latest known metered size (in bytes) of data stored in the Infrequent Access storage\n class.
" } }, "ValueInStandard": { "target": "com.amazonaws.efs#FileSystemNullableSizeValue", "traits": { "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the Standard\n storage class.
" } }, "ValueInArchive": { "target": "com.amazonaws.efs#FileSystemNullableSizeValue", "traits": { "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the Archive\n storage class.
" } } }, "traits": { "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the file system, in its\n Value field, and the time at which that size was determined in its\n Timestamp field. The value doesn't represent the size of a consistent\n snapshot of the file system, but it is eventually consistent when there are no writes to the\n file system. That is, the value represents the actual size only if the file system is not\n modified for a period longer than a couple of hours. Otherwise, the value is not necessarily\n the exact size the file system was at any instant in time.
Returned if the file system's lifecycle state is not \"available\".
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#IncorrectMountTargetState": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the mount target is not in the correct state for the\n operation.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#InsufficientThroughputCapacity": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if there's not enough capacity to provision additional throughput. This value\n might be returned when you try to create a file system in provisioned throughput mode,\n when you attempt to increase the provisioned throughput of an existing file system, or\n when you attempt to change an existing file system from Bursting Throughput to\n Provisioned Throughput mode. Try again later.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.efs#InternalServerError": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if an error occurred on the server side.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.efs#InvalidPolicyException": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode" }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the FileSystemPolicy is malformed or contains an error such\n as a parameter value that is not valid or a missing required parameter. Returned in the\n case of a policy lockout safety check error.
Returned if the request specified an IpAddress that is already in use\n in the subnet.
An array of lifecycle management policies. EFS supports a maximum of one\n policy per file system.
" } } } }, "com.amazonaws.efs#LifecyclePolicies": { "type": "list", "member": { "target": "com.amazonaws.efs#LifecyclePolicy" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.efs#LifecyclePolicy": { "type": "structure", "members": { "TransitionToIA": { "target": "com.amazonaws.efs#TransitionToIARules", "traits": { "smithy.api#documentation": "The number of days after files were last accessed in primary storage (the\n Standard storage class) at which to move them to Infrequent Access\n (IA) storage. Metadata operations such as listing the contents of a directory\n don't count as file access events.
" } }, "TransitionToPrimaryStorageClass": { "target": "com.amazonaws.efs#TransitionToPrimaryStorageClassRules", "traits": { "smithy.api#documentation": "Whether to move files back to primary (Standard) storage after they are\n accessed in IA or Archive storage. Metadata operations such as\n listing the contents of a directory don't count as file access events.
" } }, "TransitionToArchive": { "target": "com.amazonaws.efs#TransitionToArchiveRules", "traits": { "smithy.api#documentation": "The number of days after files were last accessed in primary storage (the\n Standard storage class) at which to move them to Archive\n storage. Metadata operations such as listing the contents of a directory don't count as\n file access events.
" } } }, "traits": { "smithy.api#documentation": "Describes a policy used by lifecycle management that specifies when to transition files\n into and out of storage classes. For more information, see Managing file system\n storage.
\nWhen using the put-lifecycle-configuration CLI command or the\n PutLifecycleConfiguration API action, Amazon EFS requires that each\n LifecyclePolicy object have only a single transition. This means that in a\n request body, LifecyclePolicies must be structured as an array of\n LifecyclePolicy objects, one object for each transition. For more\n information, see the request examples in PutLifecycleConfiguration.
Lists all tags for a top-level EFS resource. You must provide the ID of the\n resource that you want to retrieve the tags for.
\nThis operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
Specifies the EFS resource you want to retrieve tags for. You can retrieve tags\n for EFS file systems and access points using this API endpoint.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.efs#MaxResults", "traits": { "smithy.api#documentation": "(Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.
", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "(Optional) You can use NextToken in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.
An array of the tags for the specified EFS resource.
" } }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "\n NextToken is present if the response payload is paginated. You can use NextToken in a subsequent request to fetch the next page of access point descriptions.
Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for\n use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With\n Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you\n add and remove files, so that your applications have the storage they need, when they need it.\n For more information, see the Amazon Elastic File System API Reference and\n the Amazon Elastic File System\n User Guide.
", "smithy.api#title": "Amazon Elastic File System", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://efs.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://efs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://elasticfilesystem-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elasticfilesystem-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elasticfilesystem.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://elasticfilesystem.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 18, "nodes": "/////wAAAAH/////AAAAAAAAABAAAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAgAAAAGAAAACAAAAAcF9eEMAAAACQX14QgF9eEJAAAABAAAAA8AAAAJAAAABQAAAA8AAAAKAAAABgAAAA8AAAALAAAABwAAAA0AAAAMAAAACAX14QcF9eELAAAACAAAAA4F9eEKAAAACQX14QYF9eEHAAAACAX14QUF9eEEAAAAAwAAABIAAAARAAAACAX14QEF9eEDAAAACAX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://efs.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://efs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://efs.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://efs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://efs.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://efs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://elasticfilesystem-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://elasticfilesystem-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://elasticfilesystem.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://elasticfilesystem.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://efs-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://efs.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://efs-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://efs.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://efs-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://efs.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://elasticfilesystem.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.efs#Marker": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^.+$" } }, "com.amazonaws.efs#MaxItems": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.efs#MaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "Max results used for pagination.", "smithy.api#range": { "min": 1 } } }, "com.amazonaws.efs#ModifyMountTargetSecurityGroups": { "type": "operation", "input": { "target": "com.amazonaws.efs#ModifyMountTargetSecurityGroupsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#IncorrectMountTargetState" }, { "target": "com.amazonaws.efs#InternalServerError" }, { "target": "com.amazonaws.efs#MountTargetNotFound" }, { "target": "com.amazonaws.efs#SecurityGroupLimitExceeded" }, { "target": "com.amazonaws.efs#SecurityGroupNotFound" } ], "traits": { "smithy.api#documentation": "Modifies the set of security groups in effect for a mount target.
\nWhen you create a mount target, Amazon EFS also creates a new network interface. For\n more information, see CreateMountTarget. This operation replaces the security groups in effect for the\n network interface associated with a mount target, with the SecurityGroups\n provided in the request. This operation requires that the network interface of the mount\n target has been created and the lifecycle state of the mount target is not\n deleted.
The operation requires permissions for the following actions:
\n\n elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount\n target's file system.
\n ec2:ModifyNetworkInterfaceAttribute action on the mount target's network\n interface.
The ID of the mount target whose security groups you want to modify.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SecurityGroups": { "target": "com.amazonaws.efs#SecurityGroups", "traits": { "smithy.api#documentation": "An array of VPC security group IDs.
" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.efs#MountTargetConflict": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the mount target would violate one of the specified restrictions based\n on the file system's existing mount targets.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#MountTargetCount": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.efs#MountTargetDescription": { "type": "structure", "members": { "OwnerId": { "target": "com.amazonaws.efs#AwsAccountId", "traits": { "smithy.api#documentation": "Amazon Web Services account ID that owns the resource.
" } }, "MountTargetId": { "target": "com.amazonaws.efs#MountTargetId", "traits": { "smithy.api#documentation": "System-assigned mount target ID.
", "smithy.api#required": {} } }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "The ID of the file system for which the mount target is intended.
", "smithy.api#required": {} } }, "SubnetId": { "target": "com.amazonaws.efs#SubnetId", "traits": { "smithy.api#documentation": "The ID of the mount target's subnet.
", "smithy.api#required": {} } }, "LifeCycleState": { "target": "com.amazonaws.efs#LifeCycleState", "traits": { "smithy.api#documentation": "Lifecycle state of the mount target.
", "smithy.api#required": {} } }, "IpAddress": { "target": "com.amazonaws.efs#IpAddress", "traits": { "smithy.api#documentation": "Address at which the file system can be mounted by using the mount target.
" } }, "Ipv6Address": { "target": "com.amazonaws.efs#Ipv6Address", "traits": { "smithy.api#documentation": "The IPv6 address for the mount target.
" } }, "NetworkInterfaceId": { "target": "com.amazonaws.efs#NetworkInterfaceId", "traits": { "smithy.api#documentation": "The ID of the network interface that Amazon EFS created when it created the mount\n target.
" } }, "AvailabilityZoneId": { "target": "com.amazonaws.efs#AvailabilityZoneId", "traits": { "smithy.api#documentation": "The unique and consistent identifier of the Availability Zone that the mount target resides in.\n For example, use1-az1 is an AZ ID for the us-east-1 Region and it\n has the same location in every Amazon Web Services account.
The name of the Availability Zone in which the mount target is located. Availability Zones are\n independently mapped to names for each Amazon Web Services account. For example, the\n Availability Zone us-east-1a for your Amazon Web Services account might not be the\n same location as us-east-1a for another Amazon Web Services account.
The virtual private cloud (VPC) ID that the mount target is configured in.
" } } }, "traits": { "smithy.api#documentation": "Provides a description of a mount target.
" } }, "com.amazonaws.efs#MountTargetDescriptions": { "type": "list", "member": { "target": "com.amazonaws.efs#MountTargetDescription" } }, "com.amazonaws.efs#MountTargetId": { "type": "string", "traits": { "smithy.api#length": { "min": 13, "max": 45 }, "smithy.api#pattern": "^fsmt-[0-9a-f]{8,40}$" } }, "com.amazonaws.efs#MountTargetNotFound": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if there is no mount target with the specified ID found in the\n caller's Amazon Web Services account.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.efs#Name": { "type": "string" }, "com.amazonaws.efs#NetworkInterfaceId": { "type": "string" }, "com.amazonaws.efs#NetworkInterfaceLimitExceeded": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The calling account has reached the limit for elastic network interfaces for the\n specific Amazon Web Services Region. Either delete some network interfaces or request\n that the account quota be raised. For more information, see Amazon VPC Quotas\n in the Amazon VPC User Guide (see the Network\n interfaces per Region entry in the Network\n interfaces table).
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#NoFreeAddressesInSubnet": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if IpAddress was not specified in the request and there are\n no free IP addresses in the subnet.
Returned if no backup is specified for a One Zone EFS file system.
The POSIX user ID used for all file system operations using this access point.
", "smithy.api#required": {} } }, "Gid": { "target": "com.amazonaws.efs#Gid", "traits": { "smithy.api#documentation": "The POSIX group ID used for all file system operations using this access point.
", "smithy.api#required": {} } }, "SecondaryGids": { "target": "com.amazonaws.efs#SecondaryGids", "traits": { "smithy.api#documentation": "Secondary POSIX group IDs used for all file system operations using this access point.
" } } }, "traits": { "smithy.api#documentation": "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\n NFS clients using the access point.
" } }, "com.amazonaws.efs#ProvisionedThroughputInMibps": { "type": "double", "traits": { "smithy.api#range": { "min": 1.0 } } }, "com.amazonaws.efs#PutAccountPreferences": { "type": "operation", "input": { "target": "com.amazonaws.efs#PutAccountPreferencesRequest" }, "output": { "target": "com.amazonaws.efs#PutAccountPreferencesResponse" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#InternalServerError" } ], "traits": { "smithy.api#documentation": "Use this operation to set the account preference in the current Amazon Web Services Region\n to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new\n EFS file system and mount target resources. All existing resource IDs are not\n affected by any changes you make. You can set the ID preference during the opt-in period as\n EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs.
\nStarting in October, 2021, you will receive an error if you try to set the account preference\n to use the short 8 character format resource ID. Contact Amazon Web Services support if you\n receive an error and must use short IDs for file system and mount target resources.
\nSpecifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, either LONG_ID\n (17 characters), or SHORT_ID (8 characters).
Starting in October, 2021, you will receive an error when setting the account preference to\n SHORT_ID. Contact Amazon Web Services support if you receive an error and must\n use short IDs for file system and mount target resources.
Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
", "smithy.api#http": { "method": "PUT", "uri": "/2015-02-01/file-systems/{FileSystemId}/backup-policy", "code": 200 } } }, "com.amazonaws.efs#PutBackupPolicyRequest": { "type": "structure", "members": { "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "Specifies which EFS file system to update the backup policy for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupPolicy": { "target": "com.amazonaws.efs#BackupPolicy", "traits": { "smithy.api#documentation": "The backup policy included in the PutBackupPolicy request.
Applies an Amazon EFS\n FileSystemPolicy to an Amazon EFS file system. A file system policy is an\n IAM resource-based policy and can contain multiple policy statements. A file system always has\n exactly one file system policy, which can be the default policy or an explicit policy set or\n updated using this API operation. EFS file system policies have a 20,000 character\n limit. When an explicit policy is set, it overrides the default policy. For more information\n about the default file system policy, see \n Default EFS file system policy.
EFS file system policies have a 20,000 character limit.
\nThis operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.
The ID of the EFS file system that you want to create or update the\n FileSystemPolicy for.
The FileSystemPolicy that you're creating. Accepts a JSON formatted\n policy definition. EFS file system policies have a 20,000 character limit. To find\n out more about the elements that make up a file system policy, see Resource-based policies within Amazon EFS.
(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check. The lockout safety check \n determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system.\n Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent \n the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. \n The default value is False.\n
Use this action to manage storage for your file system. A\n LifecycleConfiguration consists of one or more LifecyclePolicy\n objects that define the following:
\n \n TransitionToIA\n \u2013\n When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access \n (IA) storage.
\n \n TransitionToArchive\n \u2013\n When to move files in the file system from their current storage class (either IA or Standard storage) into the \n Archive storage.
File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, \n TransitionToArchive must either not be set or must be later than TransitionToIA.
\nThe Archive storage class is available only for file systems that use the Elastic throughput mode \nand the General Purpose performance mode.
\n\n \n TransitionToPrimaryStorageClass\n \u2013\n Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA\n or Archive storage.
For more information, see Managing file system\n storage.
\nEach Amazon EFS file system supports one lifecycle configuration, which applies to\n all files in the file system. If a LifecycleConfiguration object already exists\n for the specified file system, a PutLifecycleConfiguration call modifies the\n existing configuration. A PutLifecycleConfiguration call with an empty\n LifecyclePolicies array in the request body deletes any existing\n LifecycleConfiguration. In the request, specify the following:
The ID for the file system for which you are enabling, disabling, or modifying\n lifecycle management.
\nA LifecyclePolicies array of LifecyclePolicy objects that\n define when to move files to IA storage, to Archive storage,\n and back to primary storage.
Amazon EFS requires that each LifecyclePolicy \n object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate \n 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\n need the same Key Management Service permissions as when you created the encrypted file system.
The ID of the file system for which you are creating the\n LifecycleConfiguration object (String).
An array of LifecyclePolicy objects that define the file system's\n LifecycleConfiguration object. A LifecycleConfiguration object\n informs lifecycle management of the following:
\n \n TransitionToIA\n \u2013 \n When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access \n (IA) storage.
\n \n TransitionToArchive\n \u2013\n When to move files in the file system from their current storage class (either IA or Standard storage) into the \n Archive storage.
File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, \n TransitionToArchive must either not be set or must be later than TransitionToIA.
\nThe Archive storage class is available only for file systems that use the Elastic throughput mode \nand the General Purpose performance mode.
\n\n \n TransitionToPrimaryStorageClass\n \u2013 Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA\n or Archive storage.
When using the put-lifecycle-configuration CLI command or the\n PutLifecycleConfiguration API action, Amazon EFS requires that each\n LifecyclePolicy object have only a single transition. This means that in a\n request body, LifecyclePolicies must be structured as an array of\n LifecyclePolicy objects, one object for each storage transition. See the example\n requests in the following section for more information.
Returned if the file system is already included in a replication configuration.>
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.efs#ReplicationConfigurationDescription": { "type": "structure", "members": { "SourceFileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "The ID of the source Amazon EFS file system that is being replicated.
", "smithy.api#required": {} } }, "SourceFileSystemRegion": { "target": "com.amazonaws.efs#RegionName", "traits": { "smithy.api#documentation": "The Amazon Web Services Region in which the source EFS file system is\n located.
", "smithy.api#required": {} } }, "SourceFileSystemArn": { "target": "com.amazonaws.efs#FileSystemArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the current source file system in the\n replication configuration.
", "smithy.api#required": {} } }, "OriginalSourceFileSystemArn": { "target": "com.amazonaws.efs#FileSystemArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the original source EFS file\n system in the replication configuration.
", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.efs#Timestamp", "traits": { "smithy.api#documentation": "Describes when the replication configuration was created.
", "smithy.api#required": {} } }, "Destinations": { "target": "com.amazonaws.efs#Destinations", "traits": { "smithy.api#documentation": "An array of destination objects. Only one destination object is supported.
", "smithy.api#required": {} } }, "SourceFileSystemOwnerId": { "target": "com.amazonaws.efs#AwsAccountId", "traits": { "smithy.api#documentation": "ID of the Amazon Web Services account in which the source file system resides.
" } } }, "traits": { "smithy.api#documentation": "Describes the replication configuration for a specific file system.
" } }, "com.amazonaws.efs#ReplicationConfigurationDescriptions": { "type": "list", "member": { "target": "com.amazonaws.efs#ReplicationConfigurationDescription" } }, "com.amazonaws.efs#ReplicationNotFound": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#documentation": "ReplicationNotFound
" } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the specified file system does not have a replication\n configuration.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.efs#ReplicationOverwriteProtection": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "REPLICATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPLICATING" } } } }, "com.amazonaws.efs#ReplicationStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } }, "PAUSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAUSED" } }, "PAUSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAUSING" } } } }, "com.amazonaws.efs#Resource": { "type": "enum", "members": { "FileSystem": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FILE_SYSTEM" } }, "MountTarget": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MOUNT_TARGET" } } }, "traits": { "smithy.api#documentation": "An EFS resource, for example a file system or a mount target." } }, "com.amazonaws.efs#ResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$" } }, "com.amazonaws.efs#ResourceIdPreference": { "type": "structure", "members": { "ResourceIdType": { "target": "com.amazonaws.efs#ResourceIdType", "traits": { "smithy.api#documentation": "Identifies the EFS resource ID preference, either LONG_ID (17\n characters) or SHORT_ID (8 characters).
Identifies the Amazon EFS resources to which the ID preference setting applies, FILE_SYSTEM and MOUNT_TARGET.
Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.
" } }, "com.amazonaws.efs#ResourceIdType": { "type": "enum", "members": { "LongId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LONG_ID" } }, "ShortId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHORT_ID" } } }, "traits": { "smithy.api#documentation": "A preference indicating a choice to use 63bit/32bit IDs for all applicable resources." } }, "com.amazonaws.efs#Resources": { "type": "list", "member": { "target": "com.amazonaws.efs#Resource" }, "traits": { "smithy.api#documentation": "EFS resources to which a preference applies to." } }, "com.amazonaws.efs#RoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" } }, "com.amazonaws.efs#RootDirectory": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.efs#Path", "traits": { "smithy.api#documentation": "Specifies the path on the EFS file system to expose as the root directory to\n NFS clients using the access point to access the EFS file system. A path can have\n up to four subdirectories. If the specified path does not exist, you are required to provide\n the CreationInfo.
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's\n RootDirectory. If the RootDirectory > Path\n specified does not exist, EFS creates the root directory using the\n CreationInfo settings when a client connects to an access point. When\n specifying the CreationInfo, you must provide values for all properties.
If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, \n attempts to mount the file system using the access point will fail.
Specifies the directory on the Amazon EFS file system that the access point\n provides access to. The access point exposes the specified file system path as the root\n directory of your file system to applications using the access point. NFS clients using the\n access point can only access data in the access point's RootDirectory and its\n subdirectories.
Returned if the number of SecurityGroups specified in the request is\n greater than the limit, which is based on account quota. Either delete some security groups\n or request that the account quota be raised. For more information, see Amazon VPC Quotas\n in the Amazon VPC User Guide (see the Security Groups\n table).\n
Returned if one of the specified security groups doesn't exist in the subnet's\n virtual private cloud (VPC).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.efs#SecurityGroups": { "type": "list", "member": { "target": "com.amazonaws.efs#SecurityGroup" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.efs#Status": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLING" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "DISABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLING" } } } }, "com.amazonaws.efs#StatusMessage": { "type": "string" }, "com.amazonaws.efs#SubnetId": { "type": "string", "traits": { "smithy.api#length": { "min": 15, "max": 47 }, "smithy.api#pattern": "^subnet-[0-9a-f]{8,40}$" } }, "com.amazonaws.efs#SubnetNotFound": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if there is no subnet with ID SubnetId provided in the\n request.
The tag key (String). The key can't start with aws:.
The value of the tag key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A tag is a key-value pair. Allowed characters are letters, white space, and numbers that\n can be represented in UTF-8, and the following characters: + - = . _ : /.
Creates a tag for an EFS resource. You can create tags for EFS file\n systems and access points using this API operation.
\nThis operation requires permissions for the elasticfilesystem:TagResource action.
The ID specifying the EFS resource that you want to create a tag for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.efs#Tags", "traits": { "smithy.api#documentation": "An array of Tag objects to add. Each Tag object is a key-value\n pair.
Returned when the CreateAccessPoint API action is called too quickly and \n the number of Access Points on the file system is nearing the \n limit of 120.
Returned if the throughput mode or amount of provisioned throughput can't be changed\n because the throughput limit of 1024 MiB/s has been reached.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.efs#ThroughputMode": { "type": "enum", "members": { "BURSTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "bursting" } }, "PROVISIONED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "provisioned" } }, "ELASTIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "elastic" } } } }, "com.amazonaws.efs#Timestamp": { "type": "timestamp" }, "com.amazonaws.efs#Token": { "type": "string", "traits": { "smithy.api#documentation": "Token used for pagination.", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^.+$" } }, "com.amazonaws.efs#TooManyRequests": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if you don\u2019t wait at least 24 hours before either changing the throughput mode, or\n decreasing the Provisioned Throughput value.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.efs#TransitionToArchiveRules": { "type": "enum", "members": { "AFTER_1_DAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_1_DAY" } }, "AFTER_7_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_7_DAYS" } }, "AFTER_14_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_14_DAYS" } }, "AFTER_30_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_30_DAYS" } }, "AFTER_60_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_60_DAYS" } }, "AFTER_90_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_90_DAYS" } }, "AFTER_180_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_180_DAYS" } }, "AFTER_270_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_270_DAYS" } }, "AFTER_365_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_365_DAYS" } } } }, "com.amazonaws.efs#TransitionToIARules": { "type": "enum", "members": { "AFTER_7_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_7_DAYS" } }, "AFTER_14_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_14_DAYS" } }, "AFTER_30_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_30_DAYS" } }, "AFTER_60_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_60_DAYS" } }, "AFTER_90_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_90_DAYS" } }, "AFTER_1_DAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_1_DAY" } }, "AFTER_180_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_180_DAYS" } }, "AFTER_270_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_270_DAYS" } }, "AFTER_365_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_365_DAYS" } } } }, "com.amazonaws.efs#TransitionToPrimaryStorageClassRules": { "type": "enum", "members": { "AFTER_1_ACCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_1_ACCESS" } } } }, "com.amazonaws.efs#Uid": { "type": "long", "traits": { "smithy.api#range": { "min": 0, "max": 4294967295 } } }, "com.amazonaws.efs#UnsupportedAvailabilityZone": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.efs#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.efs#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.efs#AccessPointNotFound" }, { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#InternalServerError" } ], "traits": { "smithy.api#documentation": "Removes tags from an EFS resource. You can remove tags from EFS file\n systems and access points using this API operation.
\nThis operation requires permissions for the elasticfilesystem:UntagResource action.
Specifies the EFS resource that you want to remove tags from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.efs#TagKeys", "traits": { "smithy.api#documentation": "The keys of the key-value tag pairs that you want to remove from the specified\n EFS resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.efs#UpdateFileSystem": { "type": "operation", "input": { "target": "com.amazonaws.efs#UpdateFileSystemRequest" }, "output": { "target": "com.amazonaws.efs#FileSystemDescription" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#IncorrectFileSystemLifeCycleState" }, { "target": "com.amazonaws.efs#InsufficientThroughputCapacity" }, { "target": "com.amazonaws.efs#InternalServerError" }, { "target": "com.amazonaws.efs#ThroughputLimitExceeded" }, { "target": "com.amazonaws.efs#TooManyRequests" } ], "traits": { "smithy.api#documentation": "Updates the throughput mode or the amount of provisioned throughput of an existing file\n system.
", "smithy.api#http": { "method": "PUT", "uri": "/2015-02-01/file-systems/{FileSystemId}", "code": 202 } } }, "com.amazonaws.efs#UpdateFileSystemProtection": { "type": "operation", "input": { "target": "com.amazonaws.efs#UpdateFileSystemProtectionRequest" }, "output": { "target": "com.amazonaws.efs#FileSystemProtectionDescription" }, "errors": [ { "target": "com.amazonaws.efs#BadRequest" }, { "target": "com.amazonaws.efs#FileSystemNotFound" }, { "target": "com.amazonaws.efs#IncorrectFileSystemLifeCycleState" }, { "target": "com.amazonaws.efs#InsufficientThroughputCapacity" }, { "target": "com.amazonaws.efs#InternalServerError" }, { "target": "com.amazonaws.efs#ReplicationAlreadyExists" }, { "target": "com.amazonaws.efs#ThroughputLimitExceeded" }, { "target": "com.amazonaws.efs#TooManyRequests" } ], "traits": { "smithy.api#documentation": "Updates protection on the file system.
\nThis operation requires permissions for the\n elasticfilesystem:UpdateFileSystemProtection action.
The ID of the file system to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ReplicationOverwriteProtection": { "target": "com.amazonaws.efs#ReplicationOverwriteProtection", "traits": { "smithy.api#documentation": "The status of the file system's replication overwrite protection.
\n\n ENABLED \u2013 The file system cannot be used as the destination file\n system in a replication configuration. The file system is writeable. Replication overwrite\n protection is ENABLED by default.
\n DISABLED \u2013 The file system can be used as the destination file\n system in a replication configuration. The file system is read-only and can only be\n modified by EFS replication.
\n REPLICATING \u2013 The file system is being used as the destination file\n system in a replication configuration. The file system is read-only and is only modified\n only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite\n protection is re-enabled and the file system becomes writeable.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.efs#UpdateFileSystemRequest": { "type": "structure", "members": { "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#documentation": "The ID of the file system that you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThroughputMode": { "target": "com.amazonaws.efs#ThroughputMode", "traits": { "smithy.api#documentation": "(Optional) Updates the file system's throughput mode. If you're not\n updating your throughput mode, you don't need to provide this value in your\n request. If you are changing the ThroughputMode to provisioned, \n you must also set a value for ProvisionedThroughputInMibps.
(Optional) The throughput, measured in mebibytes per second (MiBps), that you want to\n provision for a file system that you're creating. Required if ThroughputMode\n is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit\n depending on Region. To increase this limit, contact Amazon Web Services Support. For more information,\n see Amazon EFS\n quotas that you can increase in the Amazon EFS User\n Guide.
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.efs#VpcId": { "type": "string" } } }