Skip to content
AWS for Query.Farm

aws.accessanalyzer.get_access_preview

Example SQL Queries

SELECT * FROM
aws.accessanalyzer.get_access_preview
WHERE
"access_preview_id" = 'VALUE'
AND "analyzer_arn" = 'VALUE';

Description

Retrieves information about an access preview for the specified analyzer.

Table Definition

Column NameColumn Data Type
access_preview_id Required Input Column

The unique ID for the access preview.

VARCHAR
analyzer_arn Required Input Column

The ARN of the analyzer used to generate the access preview.

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.

access_preview

An object that contains information about the access preview.

STRUCT(
    "id" VARCHAR,
    "analyzer_arn" VARCHAR,
    "configurations" MAP(VARCHAR, STRUCT(
            "ebs_snapshot" STRUCT(
                "user_ids" VARCHAR[],
                "groups" VARCHAR[],
                "kms_key_id" VARCHAR
            ),
            "ecr_repository" STRUCT(
                "repository_policy" VARCHAR
            ),
            "iam_role" STRUCT(
                "trust_policy" VARCHAR
            ),
            "efs_file_system" STRUCT(
                "file_system_policy" VARCHAR
            ),
            "kms_key" STRUCT(
                "key_policies" MAP(VARCHAR, VARCHAR),
                "grants" STRUCT(
                    "operations" VARCHAR[],
                    "grantee_principal" VARCHAR,
                    "retiring_principal" VARCHAR,
                    "constraints" STRUCT(
                        "encryption_context_equals" MAP(VARCHAR, VARCHAR),
                        "encryption_context_subset" MAP(VARCHAR, VARCHAR)
                    ),
                    "issuing_account" VARCHAR
                )[]
            ),
            "rds_db_cluster_snapshot" STRUCT(
                "attributes" MAP(VARCHAR, STRUCT(
                        "account_ids" VARCHAR[]
                    )),
                "kms_key_id" VARCHAR
            ),
            "rds_db_snapshot" STRUCT(
                "attributes" MAP(VARCHAR, STRUCT(
                        "account_ids" VARCHAR[]
                    )),
                "kms_key_id" VARCHAR
            ),
            "secrets_manager_secret" STRUCT(
                "kms_key_id" VARCHAR,
                "secret_policy" VARCHAR
            ),
            "s3_bucket" STRUCT(
                "bucket_policy" VARCHAR,
                "bucket_acl_grants" STRUCT(
                    "permission" VARCHAR,
                    "grantee" STRUCT(
                        "id" VARCHAR,
                        "uri" VARCHAR
                    )
                )[],
                "bucket_public_access_block" STRUCT(
                    "ignore_public_acls" BOOLEAN,
                    "restrict_public_buckets" BOOLEAN
                ),
                "access_points" MAP(VARCHAR, STRUCT(
                        "access_point_policy" VARCHAR,
                        "public_access_block" STRUCT(
                            "ignore_public_acls" BOOLEAN,
                            "restrict_public_buckets" BOOLEAN
                        ),
                        "network_origin" STRUCT(
                            "vpc_configuration" STRUCT(
                                "vpc_id" VARCHAR
                            ),
                            "internet_configuration" BOOLEAN
                        )
                    ))
            ),
            "sns_topic" STRUCT(
                "topic_policy" VARCHAR
            ),
            "sqs_queue" STRUCT(
                "queue_policy" VARCHAR
            ),
            "s3_express_directory_bucket" STRUCT(
                "bucket_policy" VARCHAR
            ),
            "dynamodb_stream" STRUCT(
                "stream_policy" VARCHAR
            ),
            "dynamodb_table" STRUCT(
                "table_policy" VARCHAR
            )
        )),
    "created_at" TIMESTAMP_S,
    "status" VARCHAR,
    "status_reason" STRUCT(
        "code" VARCHAR
    )
)
Show child fields
access_preview.analyzer_arn

The ARN of the analyzer used to generate the access preview.

access_preview.configurations

A map of resource ARNs for the proposed resource configuration.

access_preview.created_at

The time at which the access preview was created.

access_preview.id

The unique ID for the access preview.

access_preview.status

The status of the access preview.

  • Creating - The access preview creation is in progress.

  • Completed - The access preview is complete. You can preview findings for external access to the resource.

  • Failed - The access preview creation has failed.

access_preview.status_reason

Provides more details about the current status of the access preview.

For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.

Show child fields
access_preview.status_reason.code

The reason code for the current status of the access preview.