Skip to content
AWS for Query.Farm

aws.storagegateway.describe_smb_file_shares

Example SQL Queries

SELECT * FROM
aws.storagegateway.describe_smb_file_shares
WHERE
"file_share_arn_list" = 'VALUE';

Description

Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.

Table Definition

Column NameColumn Data Type
file_share_arn_list Required Input Column

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

VARCHAR[]
Show child fields
file_share_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
smb_file_share_info_list

An array containing a description for each requested file share.

STRUCT(
    "file_share_arn" VARCHAR,
    "file_share_id" VARCHAR,
    "file_share_status" VARCHAR,
    "gateway_arn" VARCHAR,
    "kms_encrypted" BOOLEAN,
    "kms_key" VARCHAR,
    "path" VARCHAR,
    "role" VARCHAR,
    "location_arn" VARCHAR,
    "default_storage_class" VARCHAR,
    "object_acl" VARCHAR,
    "read_only" BOOLEAN,
    "guess_mime_type_enabled" BOOLEAN,
    "requester_pays" BOOLEAN,
    "smbacl_enabled" BOOLEAN,
    "access_based_enumeration" BOOLEAN,
    "admin_user_list" VARCHAR[],
    "valid_user_list" VARCHAR[],
    "invalid_user_list" VARCHAR[],
    "audit_destination_arn" VARCHAR,
    "authentication" VARCHAR,
    "case_sensitivity" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "file_share_name" VARCHAR,
    "cache_attributes" STRUCT(
        "cache_stale_timeout_in_seconds" BIGINT
    ),
    "notification_policy" VARCHAR,
    "vpc_endpoint_dns_name" VARCHAR,
    "bucket_region" VARCHAR,
    "oplocks_enabled" BOOLEAN
)[]
Show child fields
smb_file_share_info_list[]
Show child fields
smb_file_share_info_list[].access_based_enumeration

Indicates whether AccessBasedEnumeration is enabled.

smb_file_share_info_list[].admin_user_list[]
smb_file_share_info_list[].audit_destination_arn

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

smb_file_share_info_list[].authentication

The authentication method of the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

smb_file_share_info_list[].bucket_region

Specifies the Region of the S3 bucket where the SMB file share stores files.

This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

smb_file_share_info_list[].cache_attributes

Refresh cache information for the file share.

Show child fields
smb_file_share_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)

smb_file_share_info_list[].case_sensitivity

The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

smb_file_share_info_list[].default_storage_class

The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

smb_file_share_info_list[].file_share_arn

The Amazon Resource Name (ARN) of the file share.

smb_file_share_info_list[].file_share_id

The ID of the file share.

smb_file_share_info_list[].file_share_name

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

smb_file_share_info_list[].file_share_status

The status of the file share.

Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

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

smb_file_share_info_list[].guess_mime_type_enabled

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

Valid Values: true | false

smb_file_share_info_list[].invalid_user_list[]
smb_file_share_info_list[].kms_encrypted

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

smb_file_share_info_list[].kms_key

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

smb_file_share_info_list[].location_arn

A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.

Bucket ARN:

arn:aws:s3:::my-bucket/prefix/

Access point ARN:

arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/

If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

Access point alias:

test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

smb_file_share_info_list[].notification_policy

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{\"Upload\": {\"SettlingTimeInSeconds\": 60}}

The following example sets NotificationPolicy off.

{}

smb_file_share_info_list[].object_acl

A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private.

smb_file_share_info_list[].oplocks_enabled

Specifies whether opportunistic locking is enabled for the SMB file share.

Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

Valid Values: true | false

smb_file_share_info_list[].path

The file share path used by the SMB client to identify the mount point.

smb_file_share_info_list[].read_only

A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

Valid Values: true | false

smb_file_share_info_list[].requester_pays

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

smb_file_share_info_list[].role

The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.

smb_file_share_info_list[].smbacl_enabled

If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

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

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

smb_file_share_info_list[].tags[].value

Value of the tag key.

smb_file_share_info_list[].valid_user_list[]
smb_file_share_info_list[].vpc_endpoint_dns_name

Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.

This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.