SecurityHub / Client / list_free_trial_statuses_v2

list_free_trial_statuses_v2

SecurityHub.Client.list_free_trial_statuses_v2(**kwargs)

Lists the free trial status of Security Hub features. A delegated Security Hub administrator can list the status for accounts in its organization. Any other account can list the status only for itself. Free trial status remains available after a feature is disabled.

See also: AWS API Documentation

Request Syntax

response = client.list_free_trial_statuses_v2(
    AccountIds=[
        'string',
    ],
    Statuses=[
        'ACTIVE'|'INACTIVE',
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• AccountIds (list) –

  The Amazon Web Services account identifiers to list free trial status for. You can specify accounts other than your own only if you are a delegated Security Hub administrator.

  • (string) –

• Statuses (list) –

  The free trial statuses to filter the results by. Valid values:

  • ACTIVE returns only features with an ongoing free trial period.

  • INACTIVE returns only features whose free trial period has ended, or that never started.

  • (string) –

• MaxResults (integer) – The maximum number of results to return. If you don’t specify a value, Security Hub returns up to 100 results.

• NextToken (string) – The pagination token to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'AccountFreeTrialStatuses': [
        {
            'AccountId': 'string',
            'EvaluatedAt': datetime(2015, 1, 1),
            'FreeTrialStatuses': [
                {
                    'FeatureType': 'SECURITY_HUB_V2'|'SECURITY_HUB_V2_MULTI_CLOUD_AZURE',
                    'Status': 'ACTIVE'|'INACTIVE',
                    'StartedAt': datetime(2015, 1, 1),
                    'ExpiresAt': datetime(2015, 1, 1)
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • AccountFreeTrialStatuses (list) –

    An array of free trial statuses, one for each account in scope.

    • (dict) –

      The free trial status of each Security Hub feature for an account.

      • AccountId (string) –

        The Amazon Web Services account identifier that the free trial statuses apply to.

      • EvaluatedAt (datetime) –

        The date and time at which Security Hub evaluated the free trial statuses for this account. Every status in FreeTrialStatuses reflects this point in time.

      • FreeTrialStatuses (list) –

        An array of free trial statuses, one for each feature that has a free trial period for the account. The array is empty if the account has no free trial to report.

        • (dict) –

          The free trial period for a Security Hub feature, and whether the trial is currently active.

          • FeatureType (string) –

            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.

          • Status (string) –

            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.

          • StartedAt (datetime) –

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

          • ExpiresAt (datetime) –

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

  • NextToken (string) –

    The pagination token to use to request the next page of results. If there are no additional results, this value is null.

Exceptions

• SecurityHub.Client.exceptions.InternalServerException

• SecurityHub.Client.exceptions.ValidationException

• SecurityHub.Client.exceptions.AccessDeniedException

• SecurityHub.Client.exceptions.ResourceNotFoundException

• SecurityHub.Client.exceptions.ThrottlingException