Skip to content

aws.efs.describe_file_systems

Example SQL Queries

SELECT * FROM
aws.efs.describe_file_systems;

Description

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. This number is automatically set to 100. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

Table Definition

Column NameColumn Data Type
creation_token Input Column

(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.

VARCHAR
file_system_id Input Column

(Optional) ID of the file system whose description you want to retrieve (String).

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

file_systems

An array of file system descriptions.

STRUCT(
"owner_id" VARCHAR,
"creation_token" VARCHAR,
"file_system_id" VARCHAR,
"file_system_arn" VARCHAR,
"creation_time" TIMESTAMP_S,
"life_cycle_state" VARCHAR,
"name" VARCHAR,
"number_of_mount_targets" BIGINT,
"size_in_bytes" STRUCT(
"value" BIGINT,
"timestamp" TIMESTAMP_S,
"value_in_ia" BIGINT,
"value_in_standard" BIGINT,
"value_in_archive" BIGINT
),
"performance_mode" VARCHAR,
"encrypted" BOOLEAN,
"kms_key_id" VARCHAR,
"throughput_mode" VARCHAR,
"provisioned_throughput_in_mibps" DOUBLE,
"availability_zone_name" VARCHAR,
"availability_zone_id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"file_system_protection" STRUCT(
"replication_overwrite_protection" VARCHAR
)
)[]
Show child fields
file_systems[]
Show child fields
file_systems[].availability_zone_id

The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

file_systems[].availability_zone_name

Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.

file_systems[].creation_time

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

file_systems[].creation_token

The opaque string specified in the request.

file_systems[].encrypted

A Boolean value that, if true, indicates that the file system is encrypted.

file_systems[].file_system_arn

The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

file_systems[].file_system_id

The ID of the file system, assigned by Amazon EFS.

file_systems[].file_system_protection

Describes the protection on the file system.

Show child fields
file_systems[].file_system_protection.replication_overwrite_protection

The status of the file system's replication overwrite protection.

  • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.

  • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.

  • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

file_systems[].kms_key_id

The ID of an KMS key used to protect the encrypted file system.

file_systems[].life_cycle_state

The lifecycle phase of the file system.

file_systems[].name

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.

file_systems[].number_of_mount_targets

The current number of mount targets that the file system has. For more information, see CreateMountTarget.

file_systems[].owner_id

The Amazon Web Services account that created the file system.

file_systems[].performance_mode

The Performance mode of the file system.

file_systems[].provisioned_throughput_in_mibps

The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using ThroughputMode set to provisioned.

file_systems[].size_in_bytes

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.

Show child fields
file_systems[].size_in_bytes.timestamp

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.

file_systems[].size_in_bytes.value

The latest known metered size (in bytes) of data stored in the file system.

file_systems[].size_in_bytes.value_in_archive

The latest known metered size (in bytes) of data stored in the Archive storage class.

file_systems[].size_in_bytes.value_in_ia

The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.

file_systems[].size_in_bytes.value_in_standard

The latest known metered size (in bytes) of data stored in the Standard storage class.

file_systems[].tags[]
Show child fields
file_systems[].tags[].key

The tag key (String). The key can't start with aws:.

file_systems[].tags[].value

The value of the tag key.

file_systems[].throughput_mode

Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

marker

Present if provided by caller in the request (String).

VARCHAR