Skip to content
AWS for Query.Farm

aws.s3control.get_storage_lens_group

Example SQL Queries

SELECT * FROM
aws.s3control.get_storage_lens_group
WHERE
"name" = 'VALUE'
AND "account_id" = 'VALUE';

Description

Retrieves the Storage Lens group configuration details.

To use this operation, you must have the permission to perform the s3:GetStorageLensGroup action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.

Table Definition

Column NameColumn Data Type
account_id Required Input Column

The Amazon Web Services account ID associated with the Storage Lens group that you're trying to retrieve the details for. 

VARCHAR
name Required Input Column

The name of the Storage Lens group that you're trying to retrieve the configuration details for. 

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.

storage_lens_group

The name of the Storage Lens group that you're trying to retrieve the configuration details for. 

STRUCT(
    "name" VARCHAR,
    "filter" STRUCT(
        "match_any_prefix" VARCHAR[],
        "match_any_suffix" VARCHAR[],
        "match_any_tag" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "match_object_age" STRUCT(
            "days_greater_than" BIGINT,
            "days_less_than" BIGINT
        ),
        "match_object_size" STRUCT(
            "bytes_greater_than" BIGINT,
            "bytes_less_than" BIGINT
        ),
        "and" STRUCT(
            "match_any_prefix" VARCHAR[],
            "match_any_suffix" VARCHAR[],
            "match_any_tag" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[],
            "match_object_age" STRUCT(
                "days_greater_than" BIGINT,
                "days_less_than" BIGINT
            ),
            "match_object_size" STRUCT(
                "bytes_greater_than" BIGINT,
                "bytes_less_than" BIGINT
            )
        ),
        "or" STRUCT(
            "match_any_prefix" VARCHAR[],
            "match_any_suffix" VARCHAR[],
            "match_any_tag" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[],
            "match_object_age" STRUCT(
                "days_greater_than" BIGINT,
                "days_less_than" BIGINT
            ),
            "match_object_size" STRUCT(
                "bytes_greater_than" BIGINT,
                "bytes_less_than" BIGINT
            )
        )
    ),
    "storage_lens_group_arn" VARCHAR
)
Show child fields
storage_lens_group.filter

Sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the AND or OR logical operator is used.

Show child fields
storage_lens_group.filter.and

A logical operator that allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data. Objects must match all of the listed filter conditions that are joined by the And logical operator. Only one of each filter condition is allowed.

Show child fields
storage_lens_group.filter.and.match_any_prefix[]
storage_lens_group.filter.and.match_any_suffix[]
storage_lens_group.filter.and.match_any_tag[]
Show child fields
storage_lens_group.filter.and.match_any_tag[].key

Key of the tag

storage_lens_group.filter.and.match_any_tag[].value

Value of the tag

storage_lens_group.filter.and.match_object_age

Contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).

Show child fields
storage_lens_group.filter.and.match_object_age.days_greater_than

Specifies the maximum object age in days. Must be a positive whole number, greater than the minimum object age and less than or equal to 2,147,483,647.

storage_lens_group.filter.and.match_object_age.days_less_than

Specifies the minimum object age in days. The value must be a positive whole number, greater than 0 and less than or equal to 2,147,483,647.

storage_lens_group.filter.and.match_object_size

Contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).

Show child fields
storage_lens_group.filter.and.match_object_size.bytes_greater_than

Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.

storage_lens_group.filter.and.match_object_size.bytes_less_than

Specifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.

storage_lens_group.filter.match_any_prefix[]
storage_lens_group.filter.match_any_suffix[]
storage_lens_group.filter.match_any_tag[]
Show child fields
storage_lens_group.filter.match_any_tag[].key

Key of the tag

storage_lens_group.filter.match_any_tag[].value

Value of the tag

storage_lens_group.filter.match_object_age

Contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).

Show child fields
storage_lens_group.filter.match_object_age.days_greater_than

Specifies the maximum object age in days. Must be a positive whole number, greater than the minimum object age and less than or equal to 2,147,483,647.

storage_lens_group.filter.match_object_age.days_less_than

Specifies the minimum object age in days. The value must be a positive whole number, greater than 0 and less than or equal to 2,147,483,647.

storage_lens_group.filter.match_object_size

Contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).

Show child fields
storage_lens_group.filter.match_object_size.bytes_greater_than

Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.

storage_lens_group.filter.match_object_size.bytes_less_than

Specifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.

storage_lens_group.filter.or

A single logical operator that allows multiple filter conditions to be joined. Objects can match any of the listed filter conditions, which are joined by the Or logical operator. Only one of each filter condition is allowed.

Show child fields
storage_lens_group.filter.or.match_any_prefix[]
storage_lens_group.filter.or.match_any_suffix[]
storage_lens_group.filter.or.match_any_tag[]
Show child fields
storage_lens_group.filter.or.match_any_tag[].key

Key of the tag

storage_lens_group.filter.or.match_any_tag[].value

Value of the tag

storage_lens_group.filter.or.match_object_age

Filters objects that match the specified object age range.

Show child fields
storage_lens_group.filter.or.match_object_age.days_greater_than

Specifies the maximum object age in days. Must be a positive whole number, greater than the minimum object age and less than or equal to 2,147,483,647.

storage_lens_group.filter.or.match_object_age.days_less_than

Specifies the minimum object age in days. The value must be a positive whole number, greater than 0 and less than or equal to 2,147,483,647.

storage_lens_group.filter.or.match_object_size

Filters objects that match the specified object size range.

Show child fields
storage_lens_group.filter.or.match_object_size.bytes_greater_than

Specifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.

storage_lens_group.filter.or.match_object_size.bytes_less_than

Specifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.

storage_lens_group.name

Contains the name of the Storage Lens group.

storage_lens_group.storage_lens_group_arn

Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.