Skip to content
AWS for Query.Farm

aws.storagegateway.describe_file_system_associations

Example SQL Queries

SELECT * FROM
aws.storagegateway.describe_file_system_associations
WHERE
"file_system_association_arn_list" = 'VALUE';

Description

Gets the file system association information. This operation is only supported for FSx File Gateways.

Table Definition

Column NameColumn Data Type
file_system_association_arn_list Required Input Column

An array containing the Amazon Resource Name (ARN) of each file system association to be described.

VARCHAR[]
Show child fields
file_system_association_arn_list[]
_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_system_association_info_list

An array containing the FileSystemAssociationInfo data type of each file system association to be described. 

STRUCT(
    "file_system_association_arn" VARCHAR,
    "location_arn" VARCHAR,
    "file_system_association_status" VARCHAR,
    "audit_destination_arn" VARCHAR,
    "gateway_arn" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "cache_attributes" STRUCT(
        "cache_stale_timeout_in_seconds" BIGINT
    ),
    "endpoint_network_configuration" STRUCT(
        "ip_addresses" VARCHAR[]
    ),
    "file_system_association_status_details" STRUCT(
        "error_code" VARCHAR
    )[]
)[]
Show child fields
file_system_association_info_list[]
Show child fields
file_system_association_info_list[].audit_destination_arn

The Amazon Resource Name (ARN) of the storage used for the audit logs.

file_system_association_info_list[].cache_attributes

The refresh cache information for the file share or FSx file systems.

Show child fields
file_system_association_info_list[].cache_attributes.cache_stale_timeout_in_seconds

Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

file_system_association_info_list[].endpoint_network_configuration

Specifies network configuration information for the gateway associated with the Amazon FSx file system.

If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.

Show child fields
file_system_association_info_list[].endpoint_network_configuration.ip_addresses[]
file_system_association_info_list[].file_system_association_arn

The Amazon Resource Name (ARN) of the file system association.

file_system_association_info_list[].file_system_association_status

The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR

file_system_association_info_list[].file_system_association_status_details[]
Show child fields
file_system_association_info_list[].file_system_association_status_details[].error_code

The error code for a given file system association status.

file_system_association_info_list[].gateway_arn

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

file_system_association_info_list[].location_arn

The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference.

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

Tag key. The key can't start with aws:.

file_system_association_info_list[].tags[].value

Value of the tag key.