Skip to content

aws.fsx.describe_file_caches

Example SQL Queries

SELECT * FROM
aws.fsx.describe_file_caches;

Description

Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

  • The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value.

  • The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.

Table Definition

Column NameColumn Data Type
file_cache_ids Input Column

IDs of the caches whose descriptions you want to retrieve (String).

VARCHAR[]
Show child fields
file_cache_ids[]
max_results Input Column

The maximum number of resources to return in the response. This value must be an integer greater than zero.

BIGINT
next_token Input Column

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
file_caches

The response object for the DescribeFileCaches operation.

STRUCT(
"owner_id" VARCHAR,
"creation_time" TIMESTAMP_S,
"file_cache_id" VARCHAR,
"file_cache_type" VARCHAR,
"file_cache_type_version" VARCHAR,
"lifecycle" VARCHAR,
"failure_details" STRUCT(
"message" VARCHAR
),
"storage_capacity" BIGINT,
"vpc_id" VARCHAR,
"subnet_ids" VARCHAR[],
"network_interface_ids" VARCHAR[],
"dns_name" VARCHAR,
"kms_key_id" VARCHAR,
"resource_arn" VARCHAR,
"lustre_configuration" STRUCT(
"per_unit_storage_throughput" BIGINT,
"deployment_type" VARCHAR,
"mount_name" VARCHAR,
"weekly_maintenance_start_time" VARCHAR,
"metadata_configuration" STRUCT(
"storage_capacity" BIGINT
),
"log_configuration" STRUCT(
"level" VARCHAR,
"destination" VARCHAR
)
),
"data_repository_association_ids" VARCHAR[]
)[]
Show child fields
file_caches[]
Show child fields
file_caches[].creation_time

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

file_caches[].data_repository_association_ids[]
file_caches[].dns_name

The Domain Name System (DNS) name for the cache.

file_caches[].failure_details

A structure providing details of any failures that occurred.

Show child fields
file_caches[].failure_details.message

A message describing any failures that occurred.

file_caches[].file_cache_id

The system-generated, unique ID of the cache.

file_caches[].file_cache_type

The type of cache, which must be LUSTRE.

file_caches[].file_cache_type_version

The Lustre version of the cache, which must be 2.12.

file_caches[].kms_key_id

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

file_caches[].lifecycle

The lifecycle status of the cache. The following are the possible values and what they mean:

  • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.

  • CREATING - The new cache is being created.

  • DELETING - An existing cache is being deleted.

  • UPDATING - The cache is undergoing a customer-initiated update.

  • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

file_caches[].lustre_configuration

The configuration for the Amazon File Cache resource.

Show child fields
file_caches[].lustre_configuration.deployment_type

The deployment type of the Amazon File Cache resource, which must be CACHE_1.

file_caches[].lustre_configuration.log_configuration

The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs.

Show child fields
file_caches[].lustre_configuration.log_configuration.destination

The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

file_caches[].lustre_configuration.log_configuration.level

The data repository events that are logged by Amazon FSx.

  • WARN_ONLY - only warning events are logged.

  • ERROR_ONLY - only error events are logged.

  • WARN_ERROR - both warning events and error events are logged.

  • DISABLED - logging of data repository events is turned off.

Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

file_caches[].lustre_configuration.metadata_configuration

The configuration for a Lustre MDT (Metadata Target) storage volume.

Show child fields
file_caches[].lustre_configuration.metadata_configuration.storage_capacity

The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.

file_caches[].lustre_configuration.mount_name

You use the MountName value when mounting the cache. If you pass a cache ID to the DescribeFileCaches operation, it returns the the MountName value as part of the cache's description.

file_caches[].lustre_configuration.per_unit_storage_throughput

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only supported value is 1000.

file_caches[].lustre_configuration.weekly_maintenance_start_time

A recurring weekly time, in the format D:HH:MM.

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

file_caches[].network_interface_ids[]
file_caches[].owner_id

An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

file_caches[].resource_arn

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

file_caches[].storage_capacity

The storage capacity of the cache in gibibytes (GiB).

file_caches[].subnet_ids[]
file_caches[].vpc_id

The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.