describe-subscription¶

Description¶

Provides details about the AWS Shield Advanced subscription for an account.

Synopsis¶

  describe-subscription
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To retrieve the details of the AWS Shield Advanced protection for the account

The following describe-subscription example displays details about the Shield Advanced protection provided for the account.:

aws shield describe-subscription

Output:

{
    "Subscription": {
        "StartTime": 1534368978.0,
        "EndTime": 1597613778.0,
        "TimeCommitmentInSeconds": 63244800,
        "AutoRenew": "ENABLED",
        "Limits": [
            {
                "Type": "GLOBAL_ACCELERATOR",
                "Max": 1000
            },
            {
                "Type": "ROUTE53_HOSTED_ZONE",
                "Max": 1000
            },
            {
                "Type": "CF_DISTRIBUTION",
                "Max": 1000
            },
            {
                "Type": "ELB_LOAD_BALANCER",
                "Max": 1000
            },
            {
                "Type": "EC2_ELASTIC_IP_ALLOCATION",
                "Max": 1000
            }
        ]
    }
}

For more information, see How AWS Shield Works in the AWS Shield Advanced Developer Guide.

Output¶

Subscription -> (structure)

The AWS Shield Advanced subscription details for an account.

StartTime -> (timestamp)

The start time of the subscription, in Unix time in seconds. For more information see timestamp .

EndTime -> (timestamp)

The date and time your subscription will end.

TimeCommitmentInSeconds -> (long)

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

AutoRenew -> (string)

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.

Limits -> (list)

Specifies how many protections of a given type you can create.

(structure)

Specifies how many protections of a given type you can create.

Type -> (string)

The type of protection.

Max -> (long)

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

ProactiveEngagementStatus -> (string)

If ENABLED , the DDoS Response Team (DRT) will use email and phone to notify contacts about escalations to the DRT 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 DRT will not proactively notify contacts about escalations or to initiate proactive customer support.

SubscriptionLimits -> (structure)

Limits settings for your subscription.

ProtectionLimits -> (structure)

Limits settings on protections for your subscription.

ProtectedResourceTypeLimits -> (list)

The maximum number of resource types that you can specify in a protection.

(structure)

Specifies how many protections of a given type you can create.

Type -> (string)

The type of protection.

Max -> (long)

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

ProtectionGroupLimits -> (structure)

Limits settings on protection groups for your subscription.

MaxProtectionGroups -> (long)

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

PatternTypeLimits -> (structure)

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

ArbitraryPatternLimits -> (structure)

Limits settings on protection groups with arbitrary pattern type.

MaxMembers -> (long)

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

SubscriptionArn -> (string)

The ARN (Amazon Resource Name) of the subscription.

Table of Contents

Feedback

User Guide