Skip to content

Lists the free trial status of Security Hub features

Description

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.

Usage

securityhub_list_free_trial_statuses_v2(AccountIds, Statuses,
  MaxResults, NextToken)

Arguments

  • AccountIds

    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.

  • Statuses

    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.
  • MaxResults

    The maximum number of results to return. If you don't specify a value, Security Hub returns up to 100 results.

  • NextToken

    The pagination token to request the next page of results.

Value

A list with the following syntax:

list(
  AccountFreeTrialStatuses = list(
    list(
      AccountId = "string",
      EvaluatedAt = as.POSIXct(
        "2015-01-01"
      ),
      FreeTrialStatuses = list(
        list(
          FeatureType = "SECURITY_HUB_V2"|"SECURITY_HUB_V2_MULTI_CLOUD_AZURE",
          Status = "ACTIVE"|"INACTIVE",
          StartedAt = as.POSIXct(
            "2015-01-01"
          ),
          ExpiresAt = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_free_trial_statuses_v2(
  AccountIds = list(
    "string"
  ),
  Statuses = list(
    "ACTIVE"|"INACTIVE"
  ),
  MaxResults = 123,
  NextToken = "string"
)