Skip to content
AWS for Query.Farm

aws.shield.describe_subscription

Example SQL Queries

SELECT * FROM
aws.shield.describe_subscription;

Description

Provides details about the Shield Advanced subscription for an account.

Table Definition

Column NameColumn Data Type
_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.

subscription

The Shield Advanced subscription details for an account.

STRUCT(
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "time_commitment_in_seconds" BIGINT,
    "auto_renew" VARCHAR,
    "limits" STRUCT(
        "type" VARCHAR,
        "max" BIGINT
    )[],
    "proactive_engagement_status" VARCHAR,
    "subscription_limits" STRUCT(
        "protection_limits" STRUCT(
            "protected_resource_type_limits" STRUCT(
                "type" VARCHAR,
                "max" BIGINT
            )[]
        ),
        "protection_group_limits" STRUCT(
            "max_protection_groups" BIGINT,
            "pattern_type_limits" STRUCT(
                "arbitrary_pattern_limits" STRUCT(
                    "max_members" BIGINT
                )
            )
        )
    ),
    "subscription_arn" VARCHAR
)
Show child fields
subscription.auto_renew

If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

subscription.end_time

The date and time your subscription will end.

subscription.limits[]
Show child fields
subscription.limits[].max

The maximum number of protections that can be created for the specified Type.

subscription.limits[].type

The type of protection.

subscription.proactive_engagement_status

If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.

If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.

subscription.start_time

The start time of the subscription, in Unix time in seconds.

subscription.subscription_arn

The ARN (Amazon Resource Name) of the subscription.

subscription.subscription_limits

Limits settings for your subscription.

Show child fields
subscription.subscription_limits.protection_group_limits

Limits settings on protection groups for your subscription.

Show child fields
subscription.subscription_limits.protection_group_limits.max_protection_groups

The maximum number of protection groups that you can have at one time.

subscription.subscription_limits.protection_group_limits.pattern_type_limits

Limits settings by pattern type in the protection groups for your subscription.

Show child fields
subscription.subscription_limits.protection_group_limits.pattern_type_limits.arbitrary_pattern_limits

Limits settings on protection groups with arbitrary pattern type.

Show child fields
subscription.subscription_limits.protection_group_limits.pattern_type_limits.arbitrary_pattern_limits.max_members

The maximum number of resources you can specify for a single arbitrary pattern in a protection group.

subscription.subscription_limits.protection_limits

Limits settings on protections for your subscription.

Show child fields
subscription.subscription_limits.protection_limits.protected_resource_type_limits[]
Show child fields
subscription.subscription_limits.protection_limits.protected_resource_type_limits[].max

The maximum number of protections that can be created for the specified Type.

subscription.subscription_limits.protection_limits.protected_resource_type_limits[].type

The type of protection.

subscription.time_commitment_in_seconds

The length, in seconds, of the Shield Advanced subscription for the account.