Skip to content

FreeTrialStatus

Source code in docs_src/capo_securityhub/types/free_trial_status.py
class FreeTrialStatus(TypedDict, closed=True):
    feature_type: NotRequired["capo_securityhub.types.free_trial_type.FreeTrialType"]
    """<p>The feature that the free trial period applies to. Valid values:</p> <ul> <li> <p> <code>SECURITY_HUB_V2</code> specifies Security Hub.</p> </li> <li> <p> <code>SECURITY_HUB_V2_MULTI_CLOUD_AZURE</code> specifies Security Hub coverage for Microsoft Azure resources.</p> </li> </ul>"""
    status: NotRequired[
        "capo_securityhub.types.free_trial_status_value.FreeTrialStatusValue"
    ]
    """<p>Specifies whether the free trial period is currently active. Valid values:</p> <ul> <li> <p> <code>ACTIVE</code> specifies that the free trial period is ongoing.</p> </li> <li> <p> <code>INACTIVE</code> specifies that the free trial period has ended, or that it never started.</p> </li> </ul> <p>To determine whether a trial has expired, compare <code>ExpiresAt</code> to the current time.</p>"""
    started_at: NotRequired["capo_securityhub.types.timestamp.Timestamp"]
    """<p>The date and time at which the free trial period began.</p>"""
    expires_at: NotRequired["capo_securityhub.types.timestamp.Timestamp"]
    """<p>The date and time at which the free trial period ends.</p>"""

expires_at instance-attribute

expires_at: NotRequired[Timestamp]

The date and time at which the free trial period ends.

feature_type instance-attribute

feature_type: NotRequired[FreeTrialType]

The feature that the free trial period applies to. Valid values:

  • SECURITY_HUB_V2 specifies Security Hub.

  • SECURITY_HUB_V2_MULTI_CLOUD_AZURE specifies Security Hub coverage for Microsoft Azure resources.

started_at instance-attribute

started_at: NotRequired[Timestamp]

The date and time at which the free trial period began.

status instance-attribute

status: NotRequired[FreeTrialStatusValue]

Specifies whether the free trial period is currently active. Valid values:

  • ACTIVE specifies that the free trial period is ongoing.

  • INACTIVE specifies that the free trial period has ended, or that it never started.

To determine whether a trial has expired, compare ExpiresAt to the current time.