2019/02/19 - Amazon Elastic File System - 3 updated api methods
Changes Amazon EFS now supports adding tags to file system resources as part of the CreateFileSystem API . Using this capability, customers can now more easily enforce tag-based authorization for EFS file system resources.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:
Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating .
Returns with the description of the created file system.
Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.
Note
For basic use cases, you can use a randomly generated UUID for the creation token.
The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.
Note
The CreateFileSystem call returns while the file system's lifecycle state is still creating . You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.
This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes.
After the file system is fully created, Amazon EFS sets its lifecycle state to available , at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the elasticfilesystem:CreateFileSystem action.
See also: AWS API Documentation
Request Syntax
client.create_file_system(
CreationToken='string',
PerformanceMode='generalPurpose'|'maxIO',
Encrypted=True|False,
KmsKeyId='string',
ThroughputMode='bursting'|'provisioned',
ProvisionedThroughputInMibps=123.0,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
string
The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created.
boolean
A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem , is used to protect the encrypted file system.
string
The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:
Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab .
ARN - An Amazon Resource Name (ARN) for the key, for example 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 alias/projectKey1 .
Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .
If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.
string
The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.
float
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.
list
A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /
Key (string) -- [REQUIRED]
The tag key (String). The key can't start with aws: .
Value (string) -- [REQUIRED]
The value of the tag key.
dict
Response Syntax
{
'OwnerId': 'string',
'CreationToken': 'string',
'FileSystemId': 'string',
'CreationTime': datetime(2015, 1, 1),
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted',
'Name': 'string',
'NumberOfMountTargets': 123,
'SizeInBytes': {
'Value': 123,
'Timestamp': datetime(2015, 1, 1),
'ValueInIA': 123,
'ValueInStandard': 123
},
'PerformanceMode': 'generalPurpose'|'maxIO',
'Encrypted': True|False,
'KmsKeyId': 'string',
'ThroughputMode': 'bursting'|'provisioned',
'ProvisionedThroughputInMibps': 123.0,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
A description of the file system.
OwnerId (string) --
The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
CreationToken (string) --
The opaque string specified in the request.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
CreationTime (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
LifeCycleState (string) --
The lifecycle phase of the file system.
Name (string) --
You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
SizeInBytes (dict) --
The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
Value (integer) --
The latest known metered size (in bytes) of data stored in the file system.
Timestamp (datetime) --
The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
ValueInIA (integer) --
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
ValueInStandard (integer) --
The latest known metered size (in bytes) of data stored in the Standard storage class.
PerformanceMode (string) --
The performance mode of the file system.
Encrypted (boolean) --
A Boolean value that, if true, indicates that the file system is encrypted.
KmsKeyId (string) --
The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
ThroughputMode (string) --
The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.
ProvisionedThroughputInMibps (float) --
The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.
Tags (list) --
The tags associated with the file system, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
{'FileSystems': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}
Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker , an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker .
To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker .
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.
See also: AWS API Documentation
Request Syntax
client.describe_file_systems(
MaxItems=123,
Marker='string',
CreationToken='string',
FileSystemId='string'
)
integer
(Optional) Specifies the maximum number of file systems to return in the response (integer). Currently, this number is automatically set to 10.
string
(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off.
string
(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.
string
(Optional) ID of the file system whose description you want to retrieve (String).
dict
Response Syntax
{
'Marker': 'string',
'FileSystems': [
{
'OwnerId': 'string',
'CreationToken': 'string',
'FileSystemId': 'string',
'CreationTime': datetime(2015, 1, 1),
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted',
'Name': 'string',
'NumberOfMountTargets': 123,
'SizeInBytes': {
'Value': 123,
'Timestamp': datetime(2015, 1, 1),
'ValueInIA': 123,
'ValueInStandard': 123
},
'PerformanceMode': 'generalPurpose'|'maxIO',
'Encrypted': True|False,
'KmsKeyId': 'string',
'ThroughputMode': 'bursting'|'provisioned',
'ProvisionedThroughputInMibps': 123.0,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Marker (string) --
Present if provided by caller in the request (String).
FileSystems (list) --
An array of file system descriptions.
(dict) --
A description of the file system.
OwnerId (string) --
The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
CreationToken (string) --
The opaque string specified in the request.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
CreationTime (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
LifeCycleState (string) --
The lifecycle phase of the file system.
Name (string) --
You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
SizeInBytes (dict) --
The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
Value (integer) --
The latest known metered size (in bytes) of data stored in the file system.
Timestamp (datetime) --
The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
ValueInIA (integer) --
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
ValueInStandard (integer) --
The latest known metered size (in bytes) of data stored in the Standard storage class.
PerformanceMode (string) --
The performance mode of the file system.
Encrypted (boolean) --
A Boolean value that, if true, indicates that the file system is encrypted.
KmsKeyId (string) --
The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
ThroughputMode (string) --
The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.
ProvisionedThroughputInMibps (float) --
The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.
Tags (list) --
The tags associated with the file system, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
NextMarker (string) --
Present if there are more file systems than returned in the response (String). You can use the NextMarker in the subsequent request to fetch the descriptions.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
See also: AWS API Documentation
Request Syntax
client.update_file_system(
FileSystemId='string',
ThroughputMode='bursting'|'provisioned',
ProvisionedThroughputInMibps=123.0
)
string
[REQUIRED]
The ID of the file system that you want to update.
string
(Optional) The throughput mode that you want your file system to use. If you're not updating your throughput mode, you don't need to provide this value in your request.
float
(Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request.
dict
Response Syntax
{
'OwnerId': 'string',
'CreationToken': 'string',
'FileSystemId': 'string',
'CreationTime': datetime(2015, 1, 1),
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted',
'Name': 'string',
'NumberOfMountTargets': 123,
'SizeInBytes': {
'Value': 123,
'Timestamp': datetime(2015, 1, 1),
'ValueInIA': 123,
'ValueInStandard': 123
},
'PerformanceMode': 'generalPurpose'|'maxIO',
'Encrypted': True|False,
'KmsKeyId': 'string',
'ThroughputMode': 'bursting'|'provisioned',
'ProvisionedThroughputInMibps': 123.0,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
A description of the file system.
OwnerId (string) --
The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
CreationToken (string) --
The opaque string specified in the request.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
CreationTime (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
LifeCycleState (string) --
The lifecycle phase of the file system.
Name (string) --
You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
SizeInBytes (dict) --
The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
Value (integer) --
The latest known metered size (in bytes) of data stored in the file system.
Timestamp (datetime) --
The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
ValueInIA (integer) --
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
ValueInStandard (integer) --
The latest known metered size (in bytes) of data stored in the Standard storage class.
PerformanceMode (string) --
The performance mode of the file system.
Encrypted (boolean) --
A Boolean value that, if true, indicates that the file system is encrypted.
KmsKeyId (string) --
The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
ThroughputMode (string) --
The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.
ProvisionedThroughputInMibps (float) --
The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.
Tags (list) --
The tags associated with the file system, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.