Skip to content
AWS for Query.Farm

aws.opensearchserverless.list_access_policies

Example SQL Queries

SELECT * FROM
aws.opensearchserverless.list_access_policies
WHERE
"type" = 'VALUE';

Description

Returns information about a list of OpenSearch Serverless access policies.

Table Definition

Column NameColumn Data Type
type Required Input Column

The type of access policy.

VARCHAR
max_results Input Column

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

BIGINT
next_token Input Column

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

VARCHAR
resource Input Column

Resource filters (can be collections or indexes) that policies can apply to.

VARCHAR[]
Show child fields
resource[]
_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_summaries

Details about the requested access policies.

STRUCT(
    "created_date" BIGINT,
    "description" VARCHAR,
    "last_modified_date" BIGINT,
    "name" VARCHAR,
    "policy_version" VARCHAR,
    "type" VARCHAR
)[]
Show child fields
access_policy_summaries[]
Show child fields
access_policy_summaries[].created_date

The Epoch time when the access policy was created.

access_policy_summaries[].description

The description of the access policy.

access_policy_summaries[].last_modified_date

The date and time when the collection was last modified.

access_policy_summaries[].name

The name of the access policy.

access_policy_summaries[].policy_version

The version of the policy.

access_policy_summaries[].type

The type of access policy. Currently, the only available type is data.