Skip to content

Subscription

Source code in docs_src/capo_shield/types/subscription.py
class Subscription(TypedDict, closed=True):
    start_time: NotRequired["capo_shield.types.timestamp.Timestamp"]
    """<p>The start time of the subscription, in Unix time in seconds. </p>"""
    end_time: NotRequired["capo_shield.types.timestamp.Timestamp"]
    """<p>The date and time your subscription will end.</p>"""
    time_commitment_in_seconds: (
        "capo_shield.types.duration_in_seconds.DurationInSeconds"
    )
    """<p>The length, in seconds, of the Shield Advanced subscription for the account.</p>"""
    auto_renew: NotRequired["capo_shield.types.auto_renew.AutoRenew"]
    """<p>If <code>ENABLED</code>, the subscription will be automatically renewed at the end of the existing subscription period.</p> <p>When you initally create a subscription, <code>AutoRenew</code> is set to <code>ENABLED</code>. You can change this by submitting an <code>UpdateSubscription</code> request. If the <code>UpdateSubscription</code> request does not included a value for <code>AutoRenew</code>, the existing value for <code>AutoRenew</code> remains unchanged.</p>"""
    limits: NotRequired["capo_shield.types.limits.Limits"]
    """<p>Specifies how many protections of a given type you can create.</p>"""
    proactive_engagement_status: NotRequired[
        "capo_shield.types.proactive_engagement_status.ProactiveEngagementStatus"
    ]
    """<p>If <code>ENABLED</code>, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.</p> <p>If <code>PENDING</code>, you have requested proactive engagement and the request is pending. The status changes to <code>ENABLED</code> when your request is fully processed.</p> <p>If <code>DISABLED</code>, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support. </p>"""
    subscription_limits: "capo_shield.types.subscription_limits.SubscriptionLimits"
    """<p>Limits settings for your subscription. </p>"""
    subscription_arn: NotRequired["capo_shield.types.resource_arn.ResourceArn"]
    """<p>The ARN (Amazon Resource Name) of the subscription.</p>"""

auto_renew instance-attribute

auto_renew: NotRequired[AutoRenew]

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.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The date and time your subscription will end.

limits instance-attribute

limits: NotRequired[Limits]

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

proactive_engagement_status instance-attribute

proactive_engagement_status: NotRequired[ProactiveEngagementStatus]

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.

start_time instance-attribute

start_time: NotRequired[Timestamp]

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

subscription_arn instance-attribute

subscription_arn: NotRequired[ResourceArn]

The ARN (Amazon Resource Name) of the subscription.

subscription_limits instance-attribute

subscription_limits: SubscriptionLimits

Limits settings for your subscription.

time_commitment_in_seconds instance-attribute

time_commitment_in_seconds: DurationInSeconds

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