Skip to content
AWS for Query.Farm

aws.opensearchserverless.get_security_config

Example SQL Queries

SELECT * FROM
aws.opensearchserverless.get_security_config
WHERE
"id" = 'VALUE';

Description

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Table Definition

Column NameColumn Data Type
id Required Input Column

The unique identifier of the security configuration.

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.

security_config_detail

Details of the requested security configuration.

STRUCT(
    "config_version" VARCHAR,
    "created_date" BIGINT,
    "description" VARCHAR,
    "id" VARCHAR,
    "last_modified_date" BIGINT,
    "saml_options" STRUCT(
        "group_attribute" VARCHAR,
        "metadata" VARCHAR,
        "session_timeout" BIGINT,
        "user_attribute" VARCHAR
    ),
    "type" VARCHAR
)
Show child fields
security_config_detail.config_version

The version of the security configuration.

security_config_detail.created_date

The date the configuration was created.

security_config_detail.description

The description of the security configuration.

security_config_detail.id

The unique identifier of the security configuration.

security_config_detail.last_modified_date

The timestamp of when the configuration was last modified.

security_config_detail.saml_options

SAML options for the security configuration in the form of a key-value map.

Show child fields
security_config_detail.saml_options.group_attribute

The group attribute for this SAML integration.

security_config_detail.saml_options.metadata

The XML IdP metadata file generated from your identity provider.

security_config_detail.saml_options.session_timeout

The session timeout, in minutes. Default is 60 minutes (12 hours).

security_config_detail.saml_options.user_attribute

A user attribute for this SAML integration.

security_config_detail.type

The type of security configuration.