Skip to content
AWS for Query.Farm

aws.appstream.describe_entitlements

Example SQL Queries

SELECT * FROM
aws.appstream.describe_entitlements
WHERE
"stack_name" = 'VALUE';

Description

Retrieves a list that describes one of more entitlements.

Table Definition

Column NameColumn Data Type
stack_name Required Input Column

The name of the stack with which the entitlement is associated.

VARCHAR
max_results Input Column

The maximum size of each page of results.

BIGINT
name Input Column

The name of the entitlement.

VARCHAR
next_token Input Column

The pagination token used to retrieve the next page of results for this operation.

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.

entitlements

The entitlements.

STRUCT(
    "name" VARCHAR,
    "stack_name" VARCHAR,
    "description" VARCHAR,
    "app_visibility" VARCHAR,
    "attributes" STRUCT(
        "name" VARCHAR,
        "value" VARCHAR
    )[],
    "created_time" TIMESTAMP_S,
    "last_modified_time" TIMESTAMP_S
)[]
Show child fields
entitlements[]
Show child fields
entitlements[].app_visibility

Specifies whether all or selected apps are entitled.

entitlements[].attributes[]
Show child fields
entitlements[].attributes[].name

A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.

The following are valid values:

  • roles

  • department

  • organization

  • groups

  • title

  • costCenter

  • userType

entitlements[].attributes[].value

A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.

entitlements[].created_time

The time when the entitlement was created.

entitlements[].description

The description of the entitlement.

entitlements[].last_modified_time

The time when the entitlement was last modified.

entitlements[].name

The name of the entitlement.

entitlements[].stack_name

The name of the stack with which the entitlement is associated.