Skip to content
AWS for Query.Farm

aws.opensearchserverless.get_access_policy

Example SQL Queries

SELECT * FROM
aws.opensearchserverless.get_access_policy
WHERE
"name" = 'VALUE'
AND "type" = 'VALUE';

Description

Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the access policy.

VARCHAR
type Required Input Column

Tye type of policy. Currently, the only supported value is data.

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_policy_detail

Details about the requested access policy.

STRUCT(
    "created_date" BIGINT,
    "description" VARCHAR,
    "last_modified_date" BIGINT,
    "name" VARCHAR,
    "policy" VARCHAR,
    "policy_version" VARCHAR,
    "type" VARCHAR
)
Show child fields
access_policy_detail.created_date

The date the policy was created.

access_policy_detail.description

The description of the policy.

access_policy_detail.last_modified_date

The timestamp of when the policy was last modified.

access_policy_detail.name

The name of the policy.

access_policy_detail.policy

The JSON policy document without any whitespaces.

access_policy_detail.policy_version

The version of the policy.

access_policy_detail.type

The type of access policy.